Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.
In today’s data-driven environment, businesses require swift, reliable access to data from diverse sources to drive decision-making and operational efficiency. Recognizing this need, Superjoin is thrilled to introduce Custom API, a flexible connector that integrates any API with your preferred spreadsheet environment.
Step-by-step walkthrough: How to connect APIs to Google Sheets
1
Get Add-ons
Click on Extensions and select Add-ons and choose Get Add-ons. This action will redirect you to the Google Workspace Marketplace.
2
Search Superjoin
In the Google Workspace Marketplace pop-up window, search for Superjoin.
3
Click on Install
Click on the Install button to install Superjoin.
Note: For the best experience, install Superjoin where there’s only a single account logged in the Chrome profile.
4
Launch Superjoin
Once installed, navigate back to the Extensions menu tab in Google Sheets. Launch Superjoin from here. You should now see Superjoin running as a side panel on the right side of your screen.
5
Navigate to Queries
To begin, you can navigate to Queries , choose to Create new query.
6
Connect a New Source
Navigate to Sources, select Connect to a new source and search for Custom API.
7
Choose authorization type
Authorization in API interactions ensures that only authorized users can access specific functions or data. It acts as a gatekeeper, verifying credentials before allowing access to API resources.Superjoin’s CustomAPI supports three distinct types of authorization to cater to different access needs:
Auth type
Description
No Authorization
Ideal for public APIs where no sensitive data is involved. Access is granted without requiring any credentials, simplifying the connection process.
Basic Authorization
Utilizes a username and password to grant access. These credentials are encoded and included in the request header, providing a straightforward method to authenticate users.
Beaer Authorization
Involves a token included in the request header that represents the user’s access permissions. This token is verified by the API server to grant access, offering a token-based approach to handle user sessions and requests.
OAuth2.0 Authorization
Employs an authorization framework that allows third-party applications to access a user’s resources without exposing their credentials. Requires a client ID, client secret, scopes, access token URL, and refresh token URL. Users authenticate with the API provider, which then grants the application an access token. This token is used in subsequent requests to access resources on behalf of the user, ensuring secure and delegated access
Based on the selected authorization type, you’ll be further prompted to enter details.
8
Select request method
The request method determines how data is sent or requested from a server, playing a pivotal role in the interaction with various web services. Superjoin supports two primary HTTP request methods:
Method
Description
GET
Used primarily for retrieving data. This method requests data from a specified resource, and does not usually requires a body, unless specified in the API’s configuration. Most common method for fetching data.
POST
Also used for retrieving data, but when you need to pass on some details along with the request in the form of a body.
9
Enter URL
Specifies the address of your server, basically where your API requests are sent.
Headers play a crucial role in conveying additional information about the request or the response between the client and the server. Some APIs might require or support additional headers that control or modify the operation of the request.In Superjoin’s CustomAPI, headers are formatted as key-value pairs that can be easily added to your API requests.
In the above image we have added a header with key as API_KEY and value as 1kjvwda321wuro.
You cannot add a new header without filling both key and value fields for the previous header.
11
Request Body (payload)
The “body” of a request is crucial when using POST methods, as it contains the data you send to the server. For effective data exchange and customization in API requests through Superjoin’s CustomAPI, understanding how to format and use the body is key.Superjoin supports two flexible ways to add content to the body of your API requests, accommodating various API specifications and user preferences:
Supported types
Description
JSON Editor
This tool allows you to directly input or modify JSON formatted data. The editor provides a clear, structured way to view and edit JSON, ensuring that the data is both valid and precisely structured as the API expects.
Key value pairs
For simpler or flatter data structures, adding body content as key-value pairs is straightforward and intuitive. This approach is user-friendly, especially for those who may not be as familiar with JSON syntax.
JSON Editor
Key value pairs
12
Connect
Click “Connect” to establish the connection with the API. Superjoin will open the Data Preview upon successful creation, allowing you to preview your data.
Step-by-step walkthrough: How to connect APIs to Microsoft Excel
1
Launch Add-ins
Click on Add-ins on the right side of the Excel toolbar.
2
Get Add-in
Click on the searchbar and type “Superjoin”. The results would show our add-in under the More search results section.
3
Authenticate with your Microsoft Account
Once Superjoin launches as a side panel, just click on Sign in with Microsoft and follow the steps to authenticate your Microsoft Office account with Superjoin.
4
Launch Superjoin
You should now see Superjoin running as a side panel on the right side of your screen.
5
Navigate to Queries
To begin, you can navigate to Queries, choose to Create new query.
6
Connect a New Source
Navigate to Sources, select Connect to a new source and search for Custom API.
7
Choose authorization type
Authorization in API interactions ensures that only authorized users can access specific functions or data. It acts as a gatekeeper, verifying credentials before allowing access to API resources.Superjoin’s CustomAPI supports three distinct types of authorization to cater to different access needs:
Auth type
Description
No Authorization
Ideal for public APIs where no sensitive data is involved. Access is granted without requiring any credentials, simplifying the connection process.
Basic Authorization
Utilizes a username and password to grant access. These credentials are encoded and included in the request header, providing a straightforward method to authenticate users.
Beaer Authorization
Involves a token included in the request header that represents the user’s access permissions. This token is verified by the API server to grant access, offering a token-based approach to handle user sessions and requests.
OAuth2.0 Authorization
Employs an authorization framework that allows third-party applications to access a user’s resources without exposing their credentials. Requires a client ID, client secret, scopes, access token URL, and refresh token URL. Users authenticate with the API provider, which then grants the application an access token. This token is used in subsequent requests to access resources on behalf of the user, ensuring secure and delegated access
Based on the selected authorization type, you’ll be further prompted to enter details.
8
Select request method
The request method determines how data is sent or requested from a server, playing a pivotal role in the interaction with various web services. Superjoin supports two primary HTTP request methods:
Method
Description
GET
Used primarily for retrieving data. This method requests data from a specified resource, and does not usually requires a body, unless specified in the API’s configuration. Most common method for fetching data.
POST
Also used for retrieving data, but when you need to pass on some details along with the request in the form of a body.
9
Enter URL
Specifies the address of your server, basically where your API requests are sent.
Headers play a crucial role in conveying additional information about the request or the response between the client and the server. Some APIs might require or support additional headers that control or modify the operation of the request.In Superjoin’s CustomAPI, headers are formatted as key-value pairs that can be easily added to your API requests.
In the above image we have added a header with key as API_KEY and value as 1kjvwda321wuro.
You cannot add a new header without filling both key and value fields for the previous header.
11
Request Body (payload)
The “body” of a request is crucial when using POST methods, as it contains the data you send to the server. For effective data exchange and customization in API requests through Superjoin’s CustomAPI, understanding how to format and use the body is key.Superjoin supports two flexible ways to add content to the body of your API requests, accommodating various API specifications and user preferences:
Supported types
Description
JSON Editor
This tool allows you to directly input or modify JSON formatted data. The editor provides a clear, structured way to view and edit JSON, ensuring that the data is both valid and precisely structured as the API expects.
Key value pairs
For simpler or flatter data structures, adding body content as key-value pairs is straightforward and intuitive. This approach is user-friendly, especially for those who may not be as familiar with JSON syntax.
JSON Editor
Key value pairs
12
Connect
Click “Connect” to establish the connection with the API. Superjoin will open the Data Preview upon successful creation, allowing you to preview your data.
Head over to the Pagination page to get a detailed explanation on it.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Superjoin Docs","colors":{"primary":"#EE8245","light":"#EE8245","dark":"#EE8245"},"logo":{"light":"https://mintcdn.com/superjoin/dNa6MIx08W_Efkb9/logo/light.svg?fit=max\u0026auto=format\u0026n=dNa6MIx08W_Efkb9\u0026q=85\u0026s=742314b10d8444b5b8c18f2f97e2decd","dark":"https://mintcdn.com/superjoin/dNa6MIx08W_Efkb9/logo/dark.svg?fit=max\u0026auto=format\u0026n=dNa6MIx08W_Efkb9\u0026q=85\u0026s=a2fab640f4e4bd30c779e5510dec7bf0"},"favicon":"https://mintcdn.com/superjoin/7gRk5iUy86ROg5IF/favicon.svg?fit=max\u0026auto=format\u0026n=7gRk5iUy86ROg5IF\u0026q=85\u0026s=a1293183e706c2527f2b227f5fa86e33","appearance":{"default":"dark"},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"mailto:support@superjoin.ai","label":"Help"}],"primary":{"type":"button","label":"Install \u0026 Launch","href":"https://app.superjoin.ai/?utm_campaign=docs\u0026utm_medium=referral\u0026utm_source=superjoin-docs"}},"footer":{"socials":{"website":"https://www.superjoin.ai","x":"https://x.com/superjoinai","linkedin":"https://www.linkedin.com/company/superjoin","youtube":"https://www.youtube.com/@superjoinai"}},"seo":{"indexing":"all"},"integrations":{"gtm":{"tagId":"GTM-NHXMH22B"},"hotjar":{"hjid":"5067915","hjsv":"6"},"posthog":{"apiKey":"phc_dDrgbMd5jm9oL0YHJSJu2V7YPrwerteM1NgVga8lKfN"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Install","icon":"arrow-up-right-from-square","href":"https://app.superjoin.ai/?utm_campaign=docs\u0026utm_medium=referral\u0026utm_source=superjoin-docs"},{"anchor":"Blogs","icon":"newspaper","href":"https://www.superjoin.ai/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"superjoin","hasAudioNarration":false,"actualSubdomain":"superjoin","customDomains":["docs.superjoin.ai"],"gitSource":{"type":"github","owner":"nowstackit","repo":"user-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6abfa37d6c2960b164699d96","collectionId":"0b101bdb-1350-4529-9467-3b9c186e4c25","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6abfa37d6c2960b164699d96"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6abfa37d6c2960b164699d96","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Integrations","count":160},{"language":"default","tag":"FAQs","count":56},{"language":"default","tag":"CRM","count":31},{"language":"default","tag":"Usecases","count":28},{"language":"default","tag":"Home","count":26},{"language":"default","tag":"Features","count":19},{"language":"default","tag":"Databases \u0026 Warehouses","count":18},{"language":"default","tag":"Imports","count":13},{"language":"default","tag":"Exports","count":12},{"language":"default","tag":"Salesforce","count":11}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"integrations/customapi/overview","slug":"/integrations/customapi/overview","pageMetadata":{"sidebarTitle":"Overview","title":"How to Connect any API to your Spreadsheet","description":"Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.","href":"/integrations/customapi/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Card,CardGroup,Frame,Heading,Note,OptimizedImage,Step,Steps,Tab,Table,Tabs,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`In today’s data-driven environment, businesses require swift, reliable access to data from diverse sources to drive decision-making and operational efficiency. Recognizing this need, Superjoin is thrilled to introduce `,_jsx(`b`,{children:`Custom API`}),`, a flexible connector that integrates any API with your preferred spreadsheet environment.`]}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`Google Sheets`,id:`google-sheets`,\"data-child-heading-ids\":`[\"step-by-step-walkthrough%3A-how-to-connect-apis-to-google-sheets\"]`,children:[_jsx(Heading,{level:`2`,id:`step-by-step-walkthrough-how-to-connect-apis-to-google-sheets`,children:`Step-by-step walkthrough: How to connect APIs to Google Sheets`}),_jsxs(Steps,{titleSize:`h3`,children:[_jsxs(Step,{title:`Get Add-ons`,id:`get-add-ons`,children:[_jsxs(_components.p,{children:[`Click on `,_jsx(_components.code,{children:`Extensions`}),` and select `,_jsx(_components.code,{children:`Add-ons`}),` and choose `,_jsx(_components.code,{children:`Get Add-ons`}),`. This action will redirect you to the Google Workspace Marketplace.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/getaddons.png?fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=ba23d07d1410cd3afb25454c5581cc85`,alt:`Get Add-ons`,\"data-og-width\":`1361`,width:`1361`,\"data-og-height\":`648`,height:`648`,\"data-path\":`images/getaddons.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/getaddons.png?w=280\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=e6aad416e5dfaaace94053542b912121 280w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/getaddons.png?w=560\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=eb63b202116f0ab24ecf5c4a7c25561b 560w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/getaddons.png?w=840\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=a9ba9f7068c1a25791f0ae5a490bd00c 840w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/getaddons.png?w=1100\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=a68bd43d22763ecd72586ef6937f62a5 1100w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/getaddons.png?w=1650\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=16c0817d6467df8278aac3035f56f0fc 1650w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/getaddons.png?w=2500\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=9d6878f2e9241d6a44c352900b7ce262 2500w`})})]}),_jsx(Step,{title:`Search Superjoin`,id:`search-superjoin`,children:_jsxs(_components.p,{children:[`In the Google Workspace Marketplace pop-up window, search for `,_jsx(_components.code,{children:`Superjoin`}),`.`]})}),_jsxs(Step,{title:`Click on Install`,id:`click-on-install`,children:[_jsxs(_components.p,{children:[`Click on the `,_jsx(_components.code,{children:`Install`}),` button to install Superjoin.\n`,_jsxs(Note,{children:[_jsx(_components.strong,{children:`Note:`}),` For the best experience, install Superjoin where there’s only a single account logged in the Chrome profile.`]})]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/marketplace.png?fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=8b32a5ed819c10448985a7e3df6f7731`,alt:`Marketplace`,\"data-og-width\":`966`,width:`966`,\"data-og-height\":`884`,height:`884`,\"data-path\":`images/marketplace.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/marketplace.png?w=280\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=605fd5e471159b873e52814b0548b8e0 280w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/marketplace.png?w=560\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=4d313e2d417875b0665e4cbaa29cdc48 560w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/marketplace.png?w=840\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=7d604a4da6003396cef196c6ee6e504b 840w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/marketplace.png?w=1100\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=219d436b7306f34e8023ddf0d93da422 1100w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/marketplace.png?w=1650\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=1d07ca559c723da58cc11e347b65d6a5 1650w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/marketplace.png?w=2500\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=ff469f5bf95c3de462c0b435d0ea9514 2500w`})})]}),_jsxs(Step,{title:`Launch Superjoin`,id:`launch-superjoin`,children:[_jsxs(_components.p,{children:[`Once installed, navigate back to the `,_jsx(_components.code,{children:`Extensions`}),` menu tab in Google Sheets. Launch Superjoin from here. You should now see Superjoin running as a side panel on the right side of your screen.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/launchstackit.png?fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=14e2ecb541402cb914b79951a8faff16`,alt:`Launch Superjoin`,\"data-og-width\":`1347`,width:`1347`,\"data-og-height\":`543`,height:`543`,\"data-path\":`images/launchstackit.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/launchstackit.png?w=280\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=e2abe44a95eb5c425eecd4c0ea3a8450 280w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/launchstackit.png?w=560\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=36cfdb106af2cdcdc0ab3720fa9b6ed8 560w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/launchstackit.png?w=840\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=a0ff561247cd7423b396a286102f0a28 840w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/launchstackit.png?w=1100\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=667975bee4904309031b4f5f569457c5 1100w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/launchstackit.png?w=1650\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=a7894bc6b1f5abb84fa29e96c01773ac 1650w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/launchstackit.png?w=2500\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=c721e9b541e014b9663b68093a89d937 2500w`})})]}),_jsxs(Step,{title:`Navigate to Queries`,id:`navigate-to-queries`,children:[_jsxs(_components.p,{children:[`To begin, you can navigate to `,_jsx(_components.code,{children:`Queries`}),` , choose to `,_jsx(_components.code,{children:`Create new query`}),`.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=28cfe023be3a0bb69e89809de5727929`,alt:`Navigate to Queries`,\"data-og-width\":`1314`,width:`1314`,\"data-og-height\":`1426`,height:`1426`,\"data-path\":`images/microsftsql/homepage.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=280\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=42c63c65d6fccb48eb8977ad65e516ce 280w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=560\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=939bb5425611c215c681ed16f931c41f 560w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=840\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=bfb5bf690fc1c5dcb3df953aaf440cbb 840w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=1100\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=cbdca0566e2f6bc34a6c14e9fd098c58 1100w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=1650\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=75637747e785305af83090539057f007 1650w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=2500\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=cadf438a6e17a29dcebe46b6beb165c2 2500w`})})]}),_jsxs(Step,{title:`Connect a New Source`,id:`connect-a-new-source`,children:[_jsxs(_components.p,{children:[`Navigate to `,_jsx(_components.code,{children:`Sources`}),`, select `,_jsx(_components.code,{children:`Connect to a new source`}),` and search for `,_jsx(_components.code,{children:`Custom API`}),`.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=bbcd344e7725e9286045d8e9231798c7`,\"data-og-width\":`2172`,width:`2172`,\"data-og-height\":`1352`,height:`1352`,\"data-path\":`images/customApi/customapipage.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=8d846c5471711552b509f095742ad40d 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=f75cc8690cfe57cf5f27da2ac08aa3ae 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=a059b575f114e9d1851c0b9529093b25 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=fe444ac95b15c28fa6ded3a450bdcc45 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=f327aefa6827579078f7746b44fdc296 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=39118364fdb8374d2db6ad88993baf1d 2500w`})})]}),_jsxs(Step,{title:`Choose authorization type`,id:`choose-authorization-type`,children:[_jsx(_components.p,{children:`Authorization in API interactions ensures that only authorized users can access specific functions or data. It acts as a gatekeeper, verifying credentials before allowing access to API resources.`}),_jsx(_components.p,{children:`Superjoin’s CustomAPI supports three distinct types of authorization to cater to different access needs:`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Auth type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`No Authorization`}),_jsx(_components.td,{children:`Ideal for public APIs where no sensitive data is involved. Access is granted without requiring any credentials, simplifying the connection process.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Basic Authorization`}),_jsxs(_components.td,{children:[`Utilizes a `,_jsx(`b`,{children:`username`}),` and `,_jsx(`b`,{children:`password`}),` to grant access. These credentials are encoded and included in the request header, providing a straightforward method to authenticate users.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Beaer Authorization`}),_jsxs(_components.td,{children:[`Involves a `,_jsx(`b`,{children:`token`}),` included in the request header that represents the user’s access permissions. This token is verified by the API server to grant access, offering a token-based approach to handle user sessions and requests.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`OAuth2.0 Authorization`}),_jsxs(_components.td,{children:[`Employs an `,_jsx(`b`,{children:`authorization framework`}),` that allows third-party applications to access a user’s resources without exposing their credentials. Requires a `,_jsx(`b`,{children:`client ID`}),`, `,_jsx(`b`,{children:`client secret`}),`, `,_jsx(`b`,{children:`scopes`}),`, `,_jsx(`b`,{children:`access token URL`}),`, and `,_jsx(`b`,{children:`refresh token URL`}),`. Users authenticate with the API provider, which then grants the application an access token. This token is used in subsequent requests to access resources on behalf of the user, ensuring secure and delegated access`]})]})]})]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=eab72c42c10980033b9fa8371c6bd200`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapiauth.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=5d2bf85fa1552c9ccef931d62b7b3f08 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=5f1413e56599fca2c625176fb43965fc 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=c390568625a512578ecd0b4ddd47ff08 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=3f9d4130cbbef6291e5d55a202612cec 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=35bdb7725106284c839794022baa676c 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=a2c85127ffe9a368775dcab7a60ebcfc 2500w`})}),_jsx(_components.p,{children:`Based on the selected authorization type, you’ll be further prompted to enter details.`})]}),_jsxs(Step,{title:`Select request method`,id:`select-request-method`,children:[_jsx(_components.p,{children:`The request method determines how data is sent or requested from a server, playing a pivotal role in the interaction with various web services. Superjoin supports two primary HTTP request methods:`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Method`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET`}),_jsxs(_components.td,{children:[`Used primarily for retrieving data. This method requests data from a specified resource, and does not usually requires a `,_jsx(_components.code,{children:`body`}),`, unless specified in the API’s configuration. Most common method for fetching data.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST`}),_jsxs(_components.td,{children:[`Also used for retrieving data, but when you need to pass on some details along with the request in the form of a `,_jsx(_components.code,{children:`body`}),`.`]})]})]})]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=410d875197344cdfc74347c7c8ccca50`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapirequest.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=7a4ebdc03efd166dcf9ad6608f253205 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=7b7e355f53b04cc664f7dcfd2dd6f181 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=2c9f701fbe6d1a6080e9b9be97c11d45 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=08595d2bad7f7afab1f864d41cf2a662 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=1ae5c6455676bdadbe3bd71559de89c9 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=64f139fd978018f21aaf4dfa8337793f 2500w`})})]}),_jsxs(Step,{title:`Enter URL`,id:`enter-url`,children:[_jsx(_components.p,{children:`Specifies the address of your server, basically where your API requests are sent.`}),_jsx(Note,{children:_jsxs(_components.p,{children:[`You can also add in query parameters in your URL such as: `,_jsx(_components.a,{href:`https://api.example.com?itemId=20`,children:`https://api.example.com?itemId=20`})]})}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=99a56f5641f7e572f5bf12caed589073`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapiurl.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=470831e624e54fdf63a530c1ac56af15 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=f4307a873ba0a041545024bc5dd54365 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=ef4f05af6dad2e45dbd511c3e376443c 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=8a631f88457e3f62b24ade96ec2ba5ac 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=bc979d446f6b23986372186337e2d6b9 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=bf73a2d2ff0fd83e9d6c846ce6c7f3d9 2500w`})})]}),_jsxs(Step,{title:`Headers (optional)`,id:`headers-optional`,children:[_jsx(_components.p,{children:`Headers play a crucial role in conveying additional information about the request or the response between the client and the server. Some APIs might require or support additional headers that control or modify the operation of the request.`}),_jsx(_components.p,{children:`In Superjoin’s CustomAPI, headers are formatted as key-value pairs that can be easily added to your API requests.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=3b81c3e5b0d6565826d46203182afef6`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapiheader.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=6d17651c2f6975040c7f5d13a39d47a3 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=ebbb8f46c7059b01a7fc7f489f7e26f6 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=450ac9d909151a8535f7386edf3da489 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=322928662e01dad7a40114ca925483ce 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=2bc5fa9c8ae9c000a9b7956f5552064d 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=0d2324e99bed038906a6613dc0770d3d 2500w`})}),_jsxs(_components.p,{children:[`In the above image we have added a header with key as `,_jsx(_components.code,{children:`API_KEY`}),` and value as `,_jsx(_components.code,{children:`1kjvwda321wuro`}),`.`]}),_jsx(Warning,{children:_jsx(_components.p,{children:`You cannot add a new header without filling both key and value fields for the previous header.`})})]}),_jsxs(Step,{title:`Request Body (payload)`,id:`request-body-payload`,children:[_jsx(_components.p,{children:`The “body” of a request is crucial when using POST methods, as it contains the data you send to the server. For effective data exchange and customization in API requests through Superjoin’s CustomAPI, understanding how to format and use the body is key.`}),_jsx(_components.p,{children:`Superjoin supports two flexible ways to add content to the body of your API requests, accommodating various API specifications and user preferences:`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Supported types`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`JSON Editor`}),_jsx(_components.td,{children:`This tool allows you to directly input or modify JSON formatted data. The editor provides a clear, structured way to view and edit JSON, ensuring that the data is both valid and precisely structured as the API expects.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Key value pairs`}),_jsx(_components.td,{children:`For simpler or flatter data structures, adding body content as key-value pairs is straightforward and intuitive. This approach is user-friendly, especially for those who may not be as familiar with JSON syntax.`})]})]})]}),_jsx(Frame,{caption:`JSON Editor`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=22c5fd4cd7dfaddb6755973782a5c72d`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapijson.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=75bf752bccf8deb3bf586cf953286c19 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=5bdfb7218682732018408146f94db475 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=3ee6a2e31e65f5f4c546c506ada4dc8e 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=63234cacdada874d34abd0be8e22875f 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=5a9c570db7f2d87c2fc232f9ccb7e028 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=434f71d50bfe8d9036a2c3f505f63455 2500w`})}),_jsx(`br`,{}),_jsx(Frame,{caption:`Key value pairs`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=a7aa57635f4b3b41ae9de51eaf8921cc`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapikeyvaluepair.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=688d18f8c7ac7b6cc40e045848f3a651 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=dbdf6f07327e426f7a490710bb11639d 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=af641bc73e56d9862827f563241a692d 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=09e021bdbdecb43ecfff592b5f53d4ca 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=96523198c60099978937d53b1ef73970 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=c09e61110523b84e8429e8b56f895828 2500w`})})]}),_jsxs(Step,{title:`Connect`,id:`connect`,children:[_jsx(_components.p,{children:`Click “Connect” to establish the connection with the API. Superjoin will open the Data Preview upon successful creation, allowing you to preview your data.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=e7d0b28582b7bfa1fce9df91f6932f19`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapiconnect.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=e0159fc45d18d8e079662426f721e989 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=456a8af3ab854c4948fa3bd879cd3a98 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=4b93d235c6eedd75c22db56b1a2c5ef0 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=6b90185763bc6506da1c2ec3d203dee9 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=7cdbd4647259ec0a1657ca154a3955c6 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=8abc28389c5704db2fbb2ffad332a0a7 2500w`})})]})]})]}),_jsxs(Tab,{title:`Microsoft Excel`,id:`microsoft-excel`,\"data-child-heading-ids\":`[\"step-by-step-walkthrough%3A-how-to-connect-apis-to-microsoft-excel\"]`,children:[_jsx(Heading,{level:`2`,id:`step-by-step-walkthrough-how-to-connect-apis-to-microsoft-excel`,children:`Step-by-step walkthrough: How to connect APIs to Microsoft Excel`}),_jsxs(Steps,{titleSize:`h3`,children:[_jsxs(Step,{title:`Launch Add-ins`,id:`launch-add-ins`,children:[_jsxs(_components.p,{children:[`Click on `,_jsx(_components.code,{children:`Add-ins`}),` on the right side of the Excel toolbar.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/get-addins.png?fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=9a602917c1d56ab7f30977dc0f467293`,\"data-og-width\":`2880`,width:`2880`,\"data-og-height\":`1800`,height:`1800`,\"data-path\":`images/get-addins.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/get-addins.png?w=280\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=33f40808bd6b1149566b0c57edb74ccd 280w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/get-addins.png?w=560\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=4121d31529317edb263342c6f8f2a82d 560w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/get-addins.png?w=840\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=e0692881c914086d56f47ffa12de5126 840w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/get-addins.png?w=1100\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=a9a685c1b0491d021e1e5932ed1b492c 1100w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/get-addins.png?w=1650\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=1546b4e42515aac738304b38c71246b7 1650w, https://mintcdn.com/superjoin/YLExbgl86h2tZ50q/images/get-addins.png?w=2500\u0026fit=max\u0026auto=format\u0026n=YLExbgl86h2tZ50q\u0026q=85\u0026s=0737d230c781973d1ab3a0276058bd13 2500w`})})]}),_jsxs(Step,{title:`Get Add-in`,id:`get-add-in`,children:[_jsxs(_components.p,{children:[`Click on the searchbar and type “Superjoin”. The results would show our add-in under the `,_jsx(_components.code,{children:`More search results`}),` section.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-addin.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=2eaebe9dbede327814e129893f551325`,\"data-og-width\":`491`,width:`491`,\"data-og-height\":`665`,height:`665`,\"data-path\":`images/excel-addin.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-addin.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=6c557d07408b84db759e44b65bed8132 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-addin.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=1623e81873095ebbf99d35d283eefa72 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-addin.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=6cb4d5eba579ba32c10331a602386b9d 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-addin.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=0d8f7cce3ba5401a93062470b81a5661 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-addin.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=aa1f5a90840d95c138f8d5948031a6de 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-addin.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=8176a066910c761fe6dc863710bdaebd 2500w`})})]}),_jsxs(Step,{title:`Authenticate with your Microsoft Account`,id:`authenticate-with-your-microsoft-account`,children:[_jsxs(_components.p,{children:[`Once Superjoin launches as a side panel, just click on `,_jsx(_components.code,{children:`Sign in with Microsoft`}),` and follow the steps to authenticate your Microsoft Office account with Superjoin.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-auth.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=052b68df7e66f275c750ff01d446ac50`,\"data-og-width\":`2560`,width:`2560`,\"data-og-height\":`1440`,height:`1440`,\"data-path\":`images/excel-auth.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-auth.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=d93634c9847ace9881887260f003e679 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-auth.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=2cdbd009528b51bbf9609c3b3c3aa0f6 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-auth.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=d7dd1edca720ac314c9277cd8c23c212 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-auth.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=1dda6c21d6dda278567951d2a6669d96 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-auth.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=768cc7c7a43008f5450568e1ba799e4d 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-auth.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=1b48bc1e34a0ed918227a2d8d9f70253 2500w`})})]}),_jsxs(Step,{title:`Launch Superjoin`,id:`launch-superjoin-2`,children:[_jsx(_components.p,{children:`You should now see Superjoin running as a side panel on the right side of your screen.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-superjoin.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=ec2d8be38abd9d4fa3fcb9b4fca35788`,\"data-og-width\":`2560`,width:`2560`,\"data-og-height\":`1440`,height:`1440`,\"data-path\":`images/excel-superjoin.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-superjoin.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=9a90fb993a401f8d803780b5ae1ced4d 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-superjoin.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=9d1fc3c3940775c7fcf98c493cb9bbc9 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-superjoin.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=47dbc8604251278839aa35f80cdebb16 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-superjoin.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=a2371a37c10a3fa8c7825ac7f9c3fabf 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-superjoin.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=4f6f8cec4bc2db66c8893998f9ca90a6 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/excel-superjoin.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=70c6b599f271b305390b32e1b6fe26fc 2500w`})})]}),_jsxs(Step,{title:`Navigate to Queries`,id:`navigate-to-queries-2`,children:[_jsxs(_components.p,{children:[`To begin, you can navigate to `,_jsx(_components.code,{children:`Queries`}),`, choose to `,_jsx(_components.code,{children:`Create new query`}),`.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=28cfe023be3a0bb69e89809de5727929`,alt:`Navigate to Queries`,\"data-og-width\":`1314`,width:`1314`,\"data-og-height\":`1426`,height:`1426`,\"data-path\":`images/microsftsql/homepage.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=280\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=42c63c65d6fccb48eb8977ad65e516ce 280w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=560\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=939bb5425611c215c681ed16f931c41f 560w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=840\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=bfb5bf690fc1c5dcb3df953aaf440cbb 840w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=1100\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=cbdca0566e2f6bc34a6c14e9fd098c58 1100w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=1650\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=75637747e785305af83090539057f007 1650w, https://mintcdn.com/superjoin/gjRFjFkthepgDSdX/images/microsftsql/homepage.png?w=2500\u0026fit=max\u0026auto=format\u0026n=gjRFjFkthepgDSdX\u0026q=85\u0026s=cadf438a6e17a29dcebe46b6beb165c2 2500w`})})]}),_jsxs(Step,{title:`Connect a New Source`,id:`connect-a-new-source-2`,children:[_jsxs(_components.p,{children:[`Navigate to `,_jsx(_components.code,{children:`Sources`}),`, select `,_jsx(_components.code,{children:`Connect to a new source`}),` and search for `,_jsx(_components.code,{children:`Custom API`}),`.`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=bbcd344e7725e9286045d8e9231798c7`,\"data-og-width\":`2172`,width:`2172`,\"data-og-height\":`1352`,height:`1352`,\"data-path\":`images/customApi/customapipage.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=8d846c5471711552b509f095742ad40d 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=f75cc8690cfe57cf5f27da2ac08aa3ae 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=a059b575f114e9d1851c0b9529093b25 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=fe444ac95b15c28fa6ded3a450bdcc45 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=f327aefa6827579078f7746b44fdc296 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapipage.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=39118364fdb8374d2db6ad88993baf1d 2500w`})})]}),_jsxs(Step,{title:`Choose authorization type`,id:`choose-authorization-type-2`,children:[_jsx(_components.p,{children:`Authorization in API interactions ensures that only authorized users can access specific functions or data. It acts as a gatekeeper, verifying credentials before allowing access to API resources.`}),_jsx(_components.p,{children:`Superjoin’s CustomAPI supports three distinct types of authorization to cater to different access needs:`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Auth type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`No Authorization`}),_jsx(_components.td,{children:`Ideal for public APIs where no sensitive data is involved. Access is granted without requiring any credentials, simplifying the connection process.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Basic Authorization`}),_jsxs(_components.td,{children:[`Utilizes a `,_jsx(`b`,{children:`username`}),` and `,_jsx(`b`,{children:`password`}),` to grant access. These credentials are encoded and included in the request header, providing a straightforward method to authenticate users.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Beaer Authorization`}),_jsxs(_components.td,{children:[`Involves a `,_jsx(`b`,{children:`token`}),` included in the request header that represents the user’s access permissions. This token is verified by the API server to grant access, offering a token-based approach to handle user sessions and requests.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`OAuth2.0 Authorization`}),_jsxs(_components.td,{children:[`Employs an `,_jsx(`b`,{children:`authorization framework`}),` that allows third-party applications to access a user’s resources without exposing their credentials. Requires a `,_jsx(`b`,{children:`client ID`}),`, `,_jsx(`b`,{children:`client secret`}),`, `,_jsx(`b`,{children:`scopes`}),`, `,_jsx(`b`,{children:`access token URL`}),`, and `,_jsx(`b`,{children:`refresh token URL`}),`. Users authenticate with the API provider, which then grants the application an access token. This token is used in subsequent requests to access resources on behalf of the user, ensuring secure and delegated access`]})]})]})]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=eab72c42c10980033b9fa8371c6bd200`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapiauth.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=5d2bf85fa1552c9ccef931d62b7b3f08 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=5f1413e56599fca2c625176fb43965fc 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=c390568625a512578ecd0b4ddd47ff08 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=3f9d4130cbbef6291e5d55a202612cec 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=35bdb7725106284c839794022baa676c 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiauth.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=a2c85127ffe9a368775dcab7a60ebcfc 2500w`})}),_jsx(_components.p,{children:`Based on the selected authorization type, you’ll be further prompted to enter details.`})]}),_jsxs(Step,{title:`Select request method`,id:`select-request-method-2`,children:[_jsx(_components.p,{children:`The request method determines how data is sent or requested from a server, playing a pivotal role in the interaction with various web services. Superjoin supports two primary HTTP request methods:`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Method`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`GET`}),_jsxs(_components.td,{children:[`Used primarily for retrieving data. This method requests data from a specified resource, and does not usually requires a `,_jsx(_components.code,{children:`body`}),`, unless specified in the API’s configuration. Most common method for fetching data.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`POST`}),_jsxs(_components.td,{children:[`Also used for retrieving data, but when you need to pass on some details along with the request in the form of a `,_jsx(_components.code,{children:`body`}),`.`]})]})]})]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=410d875197344cdfc74347c7c8ccca50`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapirequest.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=7a4ebdc03efd166dcf9ad6608f253205 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=7b7e355f53b04cc664f7dcfd2dd6f181 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=2c9f701fbe6d1a6080e9b9be97c11d45 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=08595d2bad7f7afab1f864d41cf2a662 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=1ae5c6455676bdadbe3bd71559de89c9 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapirequest.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=64f139fd978018f21aaf4dfa8337793f 2500w`})})]}),_jsxs(Step,{title:`Enter URL`,id:`enter-url-2`,children:[_jsx(_components.p,{children:`Specifies the address of your server, basically where your API requests are sent.`}),_jsx(Note,{children:_jsxs(_components.p,{children:[`You can also add in query parameters in your URL such as: `,_jsx(_components.a,{href:`https://api.example.com?itemId=20`,children:`https://api.example.com?itemId=20`})]})}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=99a56f5641f7e572f5bf12caed589073`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapiurl.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=470831e624e54fdf63a530c1ac56af15 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=f4307a873ba0a041545024bc5dd54365 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=ef4f05af6dad2e45dbd511c3e376443c 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=8a631f88457e3f62b24ade96ec2ba5ac 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=bc979d446f6b23986372186337e2d6b9 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiurl.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=bf73a2d2ff0fd83e9d6c846ce6c7f3d9 2500w`})})]}),_jsxs(Step,{title:`Headers (optional)`,id:`headers-optional-2`,children:[_jsx(_components.p,{children:`Headers play a crucial role in conveying additional information about the request or the response between the client and the server. Some APIs might require or support additional headers that control or modify the operation of the request.`}),_jsx(_components.p,{children:`In Superjoin’s CustomAPI, headers are formatted as key-value pairs that can be easily added to your API requests.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=3b81c3e5b0d6565826d46203182afef6`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapiheader.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=6d17651c2f6975040c7f5d13a39d47a3 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=ebbb8f46c7059b01a7fc7f489f7e26f6 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=450ac9d909151a8535f7386edf3da489 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=322928662e01dad7a40114ca925483ce 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=2bc5fa9c8ae9c000a9b7956f5552064d 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiheader.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=0d2324e99bed038906a6613dc0770d3d 2500w`})}),_jsxs(_components.p,{children:[`In the above image we have added a header with key as `,_jsx(_components.code,{children:`API_KEY`}),` and value as `,_jsx(_components.code,{children:`1kjvwda321wuro`}),`.`]}),_jsx(Warning,{children:_jsx(_components.p,{children:`You cannot add a new header without filling both key and value fields for the previous header.`})})]}),_jsxs(Step,{title:`Request Body (payload)`,id:`request-body-payload-2`,children:[_jsx(_components.p,{children:`The “body” of a request is crucial when using POST methods, as it contains the data you send to the server. For effective data exchange and customization in API requests through Superjoin’s CustomAPI, understanding how to format and use the body is key.`}),_jsx(_components.p,{children:`Superjoin supports two flexible ways to add content to the body of your API requests, accommodating various API specifications and user preferences:`}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Supported types`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`JSON Editor`}),_jsx(_components.td,{children:`This tool allows you to directly input or modify JSON formatted data. The editor provides a clear, structured way to view and edit JSON, ensuring that the data is both valid and precisely structured as the API expects.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Key value pairs`}),_jsx(_components.td,{children:`For simpler or flatter data structures, adding body content as key-value pairs is straightforward and intuitive. This approach is user-friendly, especially for those who may not be as familiar with JSON syntax.`})]})]})]}),_jsx(Frame,{caption:`JSON Editor`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=22c5fd4cd7dfaddb6755973782a5c72d`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapijson.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=75bf752bccf8deb3bf586cf953286c19 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=5bdfb7218682732018408146f94db475 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=3ee6a2e31e65f5f4c546c506ada4dc8e 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=63234cacdada874d34abd0be8e22875f 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=5a9c570db7f2d87c2fc232f9ccb7e028 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapijson.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=434f71d50bfe8d9036a2c3f505f63455 2500w`})}),_jsx(`br`,{}),_jsx(Frame,{caption:`Key value pairs`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=a7aa57635f4b3b41ae9de51eaf8921cc`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapikeyvaluepair.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=688d18f8c7ac7b6cc40e045848f3a651 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=dbdf6f07327e426f7a490710bb11639d 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=af641bc73e56d9862827f563241a692d 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=09e021bdbdecb43ecfff592b5f53d4ca 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=96523198c60099978937d53b1ef73970 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapikeyvaluepair.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=c09e61110523b84e8429e8b56f895828 2500w`})})]}),_jsxs(Step,{title:`Connect`,id:`connect-2`,children:[_jsx(_components.p,{children:`Click “Connect” to establish the connection with the API. Superjoin will open the Data Preview upon successful creation, allowing you to preview your data.`}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=e7d0b28582b7bfa1fce9df91f6932f19`,\"data-og-width\":`1338`,width:`1338`,\"data-og-height\":`1418`,height:`1418`,\"data-path\":`images/customApi/customapiconnect.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=280\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=e0159fc45d18d8e079662426f721e989 280w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=560\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=456a8af3ab854c4948fa3bd879cd3a98 560w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=840\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=4b93d235c6eedd75c22db56b1a2c5ef0 840w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=6b90185763bc6506da1c2ec3d203dee9 1100w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=7cdbd4647259ec0a1657ca154a3955c6 1650w, https://mintcdn.com/superjoin/Fj1m3rGY5-lshl-N/images/customApi/customapiconnect.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Fj1m3rGY5-lshl-N\u0026q=85\u0026s=8abc28389c5704db2fbb2ffad332a0a7 2500w`})})]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`setup-pagination`,children:`Setup Pagination`}),`\n`,_jsx(CardGroup,{cols:1,children:_jsx(Card,{title:`Need help setting up pagination?`,icon:`life-ring`,iconType:`duotone`,href:`pagination`,children:_jsx(_components.p,{children:`Head over to the Pagination page to get a detailed explanation on it.`})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"sidebarTitle":"Overview","title":"How to Connect any API to your Spreadsheet","description":"Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.","href":"/integrations/customapi/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Step-by-step walkthrough: How to connect APIs to Google Sheets","slug":"step-by-step-walkthrough-how-to-connect-apis-to-google-sheets","depth":2,"children":[{"title":"Get Add-ons","slug":"get-add-ons","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Search Superjoin","slug":"search-superjoin","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Click on Install","slug":"click-on-install","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Launch Superjoin","slug":"launch-superjoin","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Navigate to Queries","slug":"navigate-to-queries","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Connect a New Source","slug":"connect-a-new-source","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Choose authorization type","slug":"choose-authorization-type","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Select request method","slug":"select-request-method","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Enter URL","slug":"enter-url","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Headers (optional)","slug":"headers-optional","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Request Body (payload)","slug":"request-body-payload","depth":3,"children":[],"tabId":"google-sheets"},{"title":"Connect","slug":"connect","depth":3,"children":[],"tabId":"google-sheets"}],"tabId":"google-sheets"},{"title":"Step-by-step walkthrough: How to connect APIs to Microsoft Excel","slug":"step-by-step-walkthrough-how-to-connect-apis-to-microsoft-excel","depth":2,"children":[{"title":"Launch Add-ins","slug":"launch-add-ins","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Get Add-in","slug":"get-add-in","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Authenticate with your Microsoft Account","slug":"authenticate-with-your-microsoft-account","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Launch Superjoin","slug":"launch-superjoin-2","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Navigate to Queries","slug":"navigate-to-queries-2","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Connect a New Source","slug":"connect-a-new-source-2","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Choose authorization type","slug":"choose-authorization-type-2","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Select request method","slug":"select-request-method-2","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Enter URL","slug":"enter-url-2","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Headers (optional)","slug":"headers-optional-2","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Request Body (payload)","slug":"request-body-payload-2","depth":3,"children":[],"tabId":"microsoft-excel"},{"title":"Connect","slug":"connect-2","depth":3,"children":[],"tabId":"microsoft-excel"}],"tabId":"microsoft-excel"},{"title":"Setup Pagination","slug":"setup-pagination","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"superjoin","siteName":"Superjoin Docs","title":"How to Connect any API to your Spreadsheet - Superjoin Docs","navMaps":{"firstHrefInVersion":{"v2.0":{"href":"/integrations/customapi/overview","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2025-10-06T04:31:11.508Z","originalFileLocation":"integrations/customapi/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Superjoin Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"How to Connect any API to your Spreadsheet - Superjoin Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Superjoin Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.superjoin.ai/integrations/customapi/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://superjoin.mintlify.app/_mintlify/api/og/v2?division=Custom+API\u0026amp;title=How+to+Connect+any+API+to+your+Spreadsheet\u0026amp;description=Easily+integrate+data+from+any+API+directly+into+Google+Sheets+or+Microsoft+Excel+with+a+simple+setup+process.\u0026amp;theme=ffbdc2faf898722d21cbdba8\u0026amp;signature=cff1ba7b7a33abbe44de52080733fc7f3519ddcf5738204b183d980acb59aa4e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"How to Connect any API to your Spreadsheet - Superjoin Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://superjoin.mintlify.app/_mintlify/api/og/v2?division=Custom+API\u0026amp;title=How+to+Connect+any+API+to+your+Spreadsheet\u0026amp;description=Easily+integrate+data+from+any+API+directly+into+Google+Sheets+or+Microsoft+Excel+with+a+simple+setup+process.\u0026amp;theme=ffbdc2faf898722d21cbdba8\u0026amp;signature=cff1ba7b7a33abbe44de52080733fc7f3519ddcf5738204b183d980acb59aa4e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/superjoin/YKIiXsfTkXhKCDwQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Superjoin Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EE8245\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.superjoin.ai/integrations/customapi/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/integrations/customapi/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.superjoin.ai/#organization\",\"name\":\"Superjoin Docs\",\"url\":\"https://docs.superjoin.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/superjoin/dNa6MIx08W_Efkb9/logo/light.svg?fit=max\u0026auto=format\u0026n=dNa6MIx08W_Efkb9\u0026q=85\u0026s=742314b10d8444b5b8c18f2f97e2decd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.superjoin.ai#website\",\"name\":\"Superjoin Docs\",\"url\":\"https://docs.superjoin.ai\",\"publisher\":{\"@id\":\"https://docs.superjoin.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.superjoin.ai/integrations/customapi/overview#webpage\",\"url\":\"https://docs.superjoin.ai/integrations/customapi/overview\",\"name\":\"How to Connect any API to your Spreadsheet\",\"description\":\"Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.\",\"dateModified\":\"2025-10-06T04:31:11.508Z\",\"isPartOf\":{\"@id\":\"https://docs.superjoin.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.superjoin.ai/integrations/customapi/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.superjoin.ai/integrations/customapi/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Integrations\",\"item\":\"https://docs.superjoin.ai/integrations/summary\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to Connect any API to your Spreadsheet\",\"item\":\"https://docs.superjoin.ai/integrations/customapi/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.superjoin.ai/integrations/customapi/overview#article\",\"headline\":\"How to Connect any API to your Spreadsheet\",\"name\":\"How to Connect any API to your Spreadsheet\",\"description\":\"Easily integrate data from any API directly into Google Sheets or Microsoft Excel with a simple setup process.\",\"url\":\"https://docs.superjoin.ai/integrations/customapi/overview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.superjoin.ai/integrations/customapi/overview#webpage\"},\"dateModified\":\"2025-10-06T04:31:11.508Z\",\"publisher\":{\"@id\":\"https://docs.superjoin.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.superjoin.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Superjoin Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Superjoin Docs","nav":{"global":{"anchors":[{"anchor":"Install","icon":"arrow-up-right-from-square","href":"https://app.superjoin.ai/?utm_campaign=docs\u0026utm_medium=referral\u0026utm_source=superjoin-docs"},{"anchor":"Blogs","icon":"newspaper","href":"https://www.superjoin.ai/blog"}]},"versions":[{"version":"v2.0","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/introduction"}]},{"tab":"Integrations","groups":[{"group":"Integrations","pages":[{"title":"Overview","description":"Pull data from 40+ Integrations using Superjoin","icon":"grid-2-plus","iconType":"duotone","href":"/integrations/summary"},{"group":"Custom API","icon":"code","pages":[{"sidebarTitle":"Overview","title":"How to Connect any API to your Spreadsheet","href":"/integrations/customapi/overview"},{"title":"Setup Pagination","description":"How to Setup Pagination Inside Custom API Connector of Superjoin","href":"/integrations/customapi/pagination"}]},{"group":"CRM","icon":"folder-open","pages":[{"group":"HubSpot","icon":"hubspot","pages":[{"sidebarTitle":"Overview","title":"HubSpot Data Connector for Spreadsheets","iconType":"duotone","href":"/integrations/hubspot/overview"},{"sidebarTitle":"Connect","title":"Connect your HubSpot account to Spreadsheets","href":"/integrations/hubspot/quickstart"},{"sidebarTitle":"Import Data","title":"How to import data from HubSpot to Spreadsheets","href":"/integrations/hubspot/import"},{"sidebarTitle":"Export Data","title":"What's your Export goal?","href":"/integrations/hubspot/export"},{"sidebarTitle":"Common Issues","title":"Frequently faced issues during HubSpot Connect","iconType":"duotone","href":"/integrations/hubspot/common-issues"},{"sidebarTitle":"Supported Objects","title":"Supported HubSpot Objects","iconType":"duotone","href":"/integrations/hubspot/supported-objects"},{"sidebarTitle":"Permissions","title":"Understanding HubSpot User Level Permissions","iconType":"duotone","href":"/integrations/hubspot/hubspot-permissions"},{"sidebarTitle":"Delete Connection","title":"Delete Connected HubSpot Account","iconType":"duotone","href":"/integrations/hubspot/delete-connection"},{"sidebarTitle":"Remove Superjoin","title":"Delete Superjoin from Connected HubSpot Account","iconType":"duotone","href":"/integrations/hubspot/delete-superjoin"}]},{"group":"Salesforce","icon":"salesforce","pages":[{"sidebarTitle":"Overview","title":"Salesforce Data Connector for Spreadsheets","iconType":"duotone","href":"/integrations/salesforce/overview"},{"sidebarTitle":"Connect","title":"Connect your Salesforce account to Spreadsheets","href":"/integrations/salesforce/quickstart"},{"group":"Import Data","icon":{"style":"duotone","name":"download"},"pages":[{"sidebarTitle":"Import Objects","title":"How to import data from Salesforce Objects to Spreadsheets","href":"/integrations/salesforce/import-object"},{"sidebarTitle":"Import Reports","title":"How to import data from Salesforce Reports to Spreadsheets","href":"/integrations/salesforce/import-report"},{"sidebarTitle":"Import using SOQL","title":"How to import data from Salesforce to Spreadsheets using SOQL","href":"/integrations/salesforce/import-soql"}]},{"sidebarTitle":"Export Data","title":"How to export data from your Spreadsheet to Salesforce","icon":"upload","href":"/integrations/salesforce/export"},{"sidebarTitle":"Common Issues","title":"Frequently faced issues during Salesforce Connect","iconType":"duotone","href":"/integrations/salesforce/common-issues"},{"sidebarTitle":"Supported Objects","title":"Supported Salesforce Objects","iconType":"duotone","href":"/integrations/salesforce/supported-objects"},{"sidebarTitle":"Permissions","title":"Understanding Salesforce User Level Permissions","iconType":"duotone","href":"/integrations/salesforce/salesforce-permissions"},{"sidebarTitle":"Delete Connection","title":"Delete Connected Salesforce Account","iconType":"duotone","href":"/integrations/salesforce/delete-connection"},{"sidebarTitle":"Remove Superjoin","title":"Delete Superjoin from Connected Salesforce Account","iconType":"duotone","href":"/integrations/salesforce/delete-superjoin"}]},{"group":"Freshsales","icon":{"style":"duotone","name":"F"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Freshsales to Spreadsheets","href":"/integrations/Freshsales/overview"},{"sidebarTitle":"Credentials","title":"How to acquire Freshsales Credentials?","href":"/integrations/Freshsales/credentials"}]},{"group":"Pipedrive","icon":{"style":"duotone","name":"P"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Pipedrive to Spreadsheets","href":"/integrations/Pipedrive/overview"},{"sidebarTitle":"Credentials","title":"How to acquire Pipedrive Credentials?","href":"/integrations/Pipedrive/credentials"}]},{"group":"Zoho CRM","icon":{"style":"duotone","name":"Z"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Zoho CRM to Spreadsheets","href":"/integrations/Zoho/overview"}]},{"group":"Attio","icon":"https://assets.superjoin.ai/images/attio.png","pages":[{"sidebarTitle":"Overview","title":"Attio Data Connector for Spreadsheets","iconType":"duotone","href":"/integrations/Attio/overview"},{"sidebarTitle":"Connect","title":"Connect your Attio account to Spreadsheets","href":"/integrations/Attio/quickstart"},{"sidebarTitle":"Import Data","title":"How to import data from Attio to Spreadsheets","href":"/integrations/Attio/import"},{"sidebarTitle":"Supported Objects","title":"Supported Attio Objects","iconType":"duotone","href":"/integrations/Attio/supported-objects"},{"sidebarTitle":"Common Issues","title":"Frequently faced issues during Attio Connect","iconType":"duotone","href":"/integrations/Attio/common-issues"},{"sidebarTitle":"Delete Connection","title":"Delete Connected Attio Account","iconType":"duotone","href":"/integrations/Attio/delete-connection"}]}]},{"group":"Customer Success","icon":"message-dots","pages":[{"group":"Zendesk","icon":{"style":"duotone","name":"Z"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Zendesk to Spreadsheets","href":"/integrations/Zendesk/overview"},{"sidebarTitle":"Credentials","title":"How to get Zendesk API key?","href":"/integrations/Zendesk/credentials"}]},{"sidebarTitle":"Intercom","title":"Connect Intercom to Google Sheets","icon":"intercom","iconType":"brands","href":"/integrations/Intercom"},{"title":"Outreach [Soon]","icon":"O","iconType":"duotone","href":"/integrations/Outreach"}]},{"group":"Databases \u0026 Warehouses","icon":"database","pages":[{"group":"AWS RDS","icon":"aws","pages":[{"sidebarTitle":"Overview","title":"Connect your AWS RDS Database to Google Sheets","href":"/integrations/rds/overview"},{"sidebarTitle":"IP Whitelisting","title":"How to Whitelist an IP Address in AWS RDS Server?","href":"/integrations/rds/ip-whitelisting"},{"title":"Troubleshooting","href":"/integrations/rds/troubleshooting"}]},{"group":"Microsoft SQL (Azure)","icon":{"style":"duotone","name":"microsoft"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Microsoft SQL to Google Sheets","href":"/integrations/microsoftsql/overview"}]},{"group":"MongoDB","icon":"M","pages":[{"sidebarTitle":"Overview","title":"Connect your MongoDB to Google Sheets","href":"/integrations/mongodb/overview"},{"sidebarTitle":"Credentials","title":"How to Acquire MongoDB Credentials?","href":"/integrations/mongodb/credentials"}]},{"group":"MySQL","icon":"database","pages":[{"sidebarTitle":"Overview","title":"Connect your MySQL Database to Google Sheets","href":"/integrations/mysql/overview"},{"sidebarTitle":"IP Whitelisting","title":"How to Whitelist an IP Address in MySQL Server?","href":"/integrations/mysql/ip-whitelisting"},{"sidebarTitle":"Troubleshooting","title":"How to Troubleshoot your MySQL Connection?","href":"/integrations/mysql/troubleshooting"}]},{"group":"PostgreSQL","icon":"database","pages":[{"sidebarTitle":"Overview","title":"Connect your PostgreSQL Database to Google Sheets","href":"/integrations/postgres/overview"},{"sidebarTitle":"IP Whitelisting","title":"How to Whitelist an IP Address in PostgreSQL Server?","href":"/integrations/postgres/ip-whitelisting"},{"sidebarTitle":"Troubleshooting","title":"How to Troubleshoot your PostgreSQL Connection?","href":"/integrations/postgres/troubleshooting"},{"title":"New User in PostgreSQL","href":"/integrations/postgres/create-new-user"}]},{"group":"AWS Redshift","icon":"aws","pages":[{"sidebarTitle":"Overview","title":"Connect your Redshift Database to Google Sheets","href":"/integrations/redshift/overview"},{"sidebarTitle":"IP Whitelisting","title":"How to Whitelist an IP Address in RedShift Server?","href":"/integrations/redshift/ip-whitelisting"},{"title":"Troubleshooting","href":"/integrations/redshift/troubleshooting"}]},{"group":"BigQuery","icon":"B","pages":[{"sidebarTitle":"Overview","title":"Connect your BigQuery to Google Sheets","href":"/integrations/bigquery/overview"}]},{"sidebarTitle":"Snowflake","title":"Connect your Snowflake data warehouse to Google Sheets","icon":"snowflake","iconType":"duotone","href":"/integrations/Snowflake"}]},{"group":"Marketing","icon":"M","pages":[{"group":"Google Analytics","icon":"signal-good","pages":[{"sidebarTitle":"Overview","title":"Connect your Google Analytics to Spreadsheets","href":"/integrations/GoogleAnalytics/overview"}]},{"group":"Google Ads","icon":"google","pages":[{"sidebarTitle":"Overview","title":"Connect your Google Ads to Spreadsheets","href":"/integrations/GoogleAds/overview"}]},{"group":"Facebook Ads","icon":"Facebook","pages":[{"sidebarTitle":"Overview","title":"Connect your Meta Ads to Spreadsheets","iconType":"duotone","href":"/integrations/facebook/overview"}]},{"sidebarTitle":"Linkedin Ads","title":"Connect Linkedin account to Google Sheets","icon":"linkedin","iconType":"duotone","href":"/integrations/LinkedinAds"},{"group":"Google Search Console","icon":"google","pages":[{"sidebarTitle":"Overview","title":"Connect your Google Search Console to Spreadsheets","href":"/integrations/googlesearchconsole/overview"}]},{"group":"Mailchimp","icon":{"style":"brands","name":"mailchimp"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Mailchimp to Spreadsheets","href":"/integrations/Mailchimp/overview"},{"sidebarTitle":"Credentials","title":"How to acquire MailChimp Credentials?","href":"/integrations/Mailchimp/credentials"}]}]},{"group":"Payments \u0026 Billing","icon":"money-bill","pages":[{"group":"Chargebee","icon":"C","pages":[{"sidebarTitle":"Overview","title":"Connect your Chargebee to Spreadsheets","iconType":"duotone","href":"/integrations/chargebee/overview"},{"sidebarTitle":"API key","title":"How to find API key in Chargebee","href":"/integrations/chargebee/create-key"}]},{"group":"PayPal","icon":{"style":"brands","name":"paypal"},"pages":[{"sidebarTitle":"Overview","title":"Connect your PayPal to Google Sheets","iconType":"duotone","href":"/integrations/paypal/overview"},{"sidebarTitle":"API Credentials","title":"Creating PayPal API Credentials","iconType":"duotone","href":"/integrations/paypal/create-key"}]},{"sidebarTitle":"Recurly","title":"Connect Recurly to Google Sheets","icon":"R","iconType":"duotone","href":"/integrations/Recurly"},{"group":"Stripe","icon":{"style":"brands","name":"stripe-s"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Stripe to Google Sheets","href":"/integrations/Stripe/overview"},{"sidebarTitle":"Credentials","title":"How to get Stripe API key?","href":"/integrations/Stripe/credentials"}]},{"group":"Xero","icon":{"style":"duotone","name":"X"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Xero to Google Sheets","href":"/integrations/Xero/overview"}]}]},{"group":"Other Integrations","icon":"merge","pages":[{"group":"Vitaly","icon":{"style":"duotone","name":"V"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Vitally to Google Sheets","href":"/integrations/vitally/overview"}]},{"group":"Airtable","icon":"table","pages":[{"sidebarTitle":"Overview","title":"Connect your Airtable to Google Sheets","href":"/integrations/Airtable/overview"},{"sidebarTitle":"Credentials","title":"How to Acquire Airtable Credentials?","href":"/integrations/Airtable/credentials"}]},{"group":"Jira","icon":{"style":"brands","name":"jira"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Jira to Google Sheets","href":"/integrations/Jira/overview"},{"sidebarTitle":"Credentials","title":"How to acquire Jira API token?","href":"/integrations/Jira/credentials"}]},{"group":"Shopify","icon":{"style":"brands","name":"shopify"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Shopify to Google Sheets","href":"/integrations/Shopify/overview"},{"sidebarTitle":"Credentials","title":"How to acquire Shopify API token?","href":"/integrations/Shopify/credentials"}]},{"group":"Monday","icon":{"style":"duotone","name":"M"},"pages":[{"sidebarTitle":"Overview","title":"Connect your Monday to Google Sheets","href":"/integrations/Monday/overview"},{"sidebarTitle":"Credentials","title":"How to acquire Monday Credentials?","href":"/integrations/Monday/credentials"}]}]}]}]},{"tab":"Usecases","pages":[{"title":"Usecases","href":"/usecases/build-dynamic-dashboard-google-sheets-superjoin"}]},{"tab":"FAQs","pages":[{"title":"FAQs","href":"/faqs/missing-data-superjoin-preview"}]},{"tab":"Glossary","pages":[{"title":"Glossary","href":"/glossary/superjoin-terminology-glossary"}]},{"tab":"Superjoin APIs","pages":[{"title":"Superjoin APIs","href":"/superjoin-apis/authorization"}]}]}]},"basePath":"","title":"How to Connect any API to your Spreadsheet - Superjoin Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-DXXFP6nH.js","DynamicMarkdown-B54_zNBF.js","zoom-image-lightbox-BG6oD64b.js","lightbox-handle-r17bVUz3.js"]}