# \#api

**URL:** https://community.synatic.com/tag/api/36.md

[Latest](https://community.synatic.com/latest.md) · [Categories](https://community.synatic.com/categories.md) · [Tags](https://community.synatic.com/tags.md)

---

## [How to group API paths together in the Gateway](https://community.synatic.com/t/how-to-group-api-paths-together-in-the-gateway/310)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [November 29, 2022, 3:19pm UTC](https://community.synatic.com/t/how-to-group-api-paths-together-in-the-gateway/310 "2022-11-29T15:19:26Z")

</div>

If you require to group paths together in the Gateway, please follow the below instructions: Click on Tags in your API configuration setting and add a tag by clicking on the highlighted plus icon. Input a tag name, cli…

---

## [How to Post a PDF to an API Endpoint](https://community.synatic.com/t/how-to-post-a-pdf-to-an-api-endpoint/421)

<div class="topic-metadata">

**Author:** [@Faizel](https://community.synatic.com/u/Faizel)\
**Replies:** 0\
**Last updated:** [May 4, 2024, 7:43am UTC](https://community.synatic.com/t/how-to-post-a-pdf-to-an-api-endpoint/421 "2024-05-04T07:43:38Z")

</div>

If you require to generate a PDF document and send it to an API endpoint, please follow the instructions below: Illustrated below is an overview of the process, We generate a PDF document and send it to a REST API, The …

---

## [How to return an API response from a destination](https://community.synatic.com/t/how-to-return-an-api-response-from-a-destination/403)

<div class="topic-metadata">

**Author:** [@Faizel](https://community.synatic.com/u/Faizel)\
**Replies:** 0\
**Last updated:** [January 29, 2024, 11:25am UTC](https://community.synatic.com/t/how-to-return-an-api-response-from-a-destination/403 "2024-01-29T11:25:23Z")

</div>

If required to use an API that requires a body to be sent and a response to be received, please follow the instructions below: Illustrated in the image below is an example of a flow that prepares a JSON body to send to …

---

## [How to use the AMS360 Data Lake API](https://community.synatic.com/t/how-to-use-the-ams360-data-lake-api/413)

<div class="topic-metadata">

**Author:** [@praise](https://community.synatic.com/u/praise)\
**Replies:** 0\
**Last updated:** [February 26, 2024, 9:35am UTC](https://community.synatic.com/t/how-to-use-the-ams360-data-lake-api/413 "2024-02-26T09:35:09Z")

</div>

AMS360 Data Lake API is used to extract data from a database using an API instead of an SQL query via a VPN Solution. There are two main flows that need to be executed to extract data from the API. Firstly, authorizatio…

---

## [Need help interpreting an Excel file sent from K2 to Synatic](https://community.synatic.com/t/need-help-interpreting-an-excel-file-sent-from-k2-to-synatic/408)

<div class="topic-metadata">

**Author:** [@Flowfactory](https://community.synatic.com/u/Flowfactory)\
**Replies:** 1\
**Last updated:** [February 7, 2024, 12:36pm UTC](https://community.synatic.com/t/need-help-interpreting-an-excel-file-sent-from-k2-to-synatic/408 "2024-02-07T12:36:56Z")

</div>

Hello, I’m experiencing difficulties with interpreting an Excel file sent from K2 to Synatic. Although the file is received correctly, I’m encountering issues with interpreting its content once it arrives in our environ…

---

## [How to call/reference parameters in an API URL](https://community.synatic.com/t/how-to-call-reference-parameters-in-an-api-url/148)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [December 1, 2021, 2:48pm UTC](https://community.synatic.com/t/how-to-call-reference-parameters-in-an-api-url/148 "2021-12-01T14:48:44Z")

</div>

In order to reference or call a parameter value from your API, you need to add the highlighted code in your Calculator step as shown below. This code is used to reference the parameter in your API URL in the HTTP Service…

---

## [How to integrate buffer data from one organization to another organization](https://community.synatic.com/t/how-to-integrate-buffer-data-from-one-organization-to-another-organization/323)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [February 7, 2023, 6:49pm UTC](https://community.synatic.com/t/how-to-integrate-buffer-data-from-one-organization-to-another-organization/323 "2023-02-07T18:49:32Z")

</div>

Linking buffers when linking organizations does link the buffer schema but it does not integrate the buffer data/ values. In order to integrate the buffer data/ values, please follow the below instructions: NB: It cons…

---

## [How to delay the number of requests when pulling records from an API](https://community.synatic.com/t/how-to-delay-the-number-of-requests-when-pulling-records-from-an-api/196)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [March 31, 2022, 9:48am UTC](https://community.synatic.com/t/how-to-delay-the-number-of-requests-when-pulling-records-from-an-api/196 "2022-03-31T09:48:03Z")

</div>

When transferring data from a source to a destination in our tool, records will go through one at a time. If there are a lot of requests from an API, there is a chance that the records could be overlapping and not pulli…

---

## [How to create an oData API in the API Builder](https://community.synatic.com/t/how-to-create-an-odata-api-in-the-api-builder/236)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [May 30, 2022, 1:39pm UTC](https://community.synatic.com/t/how-to-create-an-odata-api-in-the-api-builder/236 "2022-05-30T13:39:45Z")

</div>

If you require to create an oData API type in the API Builder, you need to do the following steps: 1. Regenerate the API Key for your org by clicking on the menu and then clicking on Settings as highlighted in the image…

---

## [How to send data or media/ MIME type to an API](https://community.synatic.com/t/how-to-send-data-or-media-mime-type-to-an-api/213)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [April 21, 2022, 11:45am UTC](https://community.synatic.com/t/how-to-send-data-or-media-mime-type-to-an-api/213 "2022-04-21T11:45:34Z")

</div>

A media/ MIME type can consist of a file, image, record, array, message, text, audio or video. The following is how it can be sent to an API: Illustrated in the image below is an example of a flow which will run as an a…

---

## [How to reference a record value in an API URL](https://community.synatic.com/t/how-to-reference-a-record-value-in-an-api-url/145)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [November 30, 2021, 4:51pm UTC](https://community.synatic.com/t/how-to-reference-a-record-value-in-an-api-url/145 "2021-11-30T16:51:54Z")

</div>

In order to reference or call a record value from your API URL in the HTTP Service step, you need to add “{@record.id}” in your API URL as highlighted below. It will return all the records from the API that you created. …

---

## [How to add a return limit variable in an API URL](https://community.synatic.com/t/how-to-add-a-return-limit-variable-in-an-api-url/188)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [February 28, 2022, 11:40am UTC](https://community.synatic.com/t/how-to-add-a-return-limit-variable-in-an-api-url/188 "2022-02-28T11:40:19Z")

</div>

The default return limit in an API is 50 records. In order to set a higher return limit, you need to add “?$limit=500” in your API URL as highlighted in the below image. It will return the given number of records that w…

---

## [How to return API status codes on flows with errors](https://community.synatic.com/t/how-to-return-api-status-codes-on-flows-with-errors/180)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [February 2, 2022, 9:52am UTC](https://community.synatic.com/t/how-to-return-api-status-codes-on-flows-with-errors/180 "2022-02-02T09:52:05Z")

</div>

Illustrated in the image below is an example of a flow with the Record Generator as the source step and a Buffer as the destination step. First enable the “break on error” option in the details of a flow as shown in …

---

## [Connecting up REST and Odata API endpoints with Synatic](https://community.synatic.com/t/connecting-up-rest-and-odata-api-endpoints-with-synatic/79)

<div class="topic-metadata">

**Author:** [@wesley](https://community.synatic.com/u/wesley)\
**Replies:** 0\
**Last updated:** [March 12, 2021, 11:18am UTC](https://community.synatic.com/t/connecting-up-rest-and-odata-api-endpoints-with-synatic/79 "2021-03-12T11:18:26Z")

</div>

Here is a guide on how to connect up to REST or Odata endpoints within minutes.
