# API Builder/Gateway

**URL:** https://community.synatic.com/c/faqs/api-builder/10.md

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

---

## [About the API Builder/Gateway category](https://community.synatic.com/t/about-the-api-builder-gateway-category/19)

<div class="topic-metadata">

**Author:** [@shaun](https://community.synatic.com/u/shaun)\
**Replies:** 0

</div>

---

## [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 upload an HTML file via a REST API](https://community.synatic.com/t/how-to-upload-an-html-file-via-a-rest-api/393)

<div class="topic-metadata">

**Author:** [@Faizel](https://community.synatic.com/u/Faizel)\
**Replies:** 0\
**Last updated:** [November 21, 2023, 10:17am UTC](https://community.synatic.com/t/how-to-upload-an-html-file-via-a-rest-api/393 "2023-11-21T10:17:11Z")

</div>

If required to post a file via a REST gateway and send it to a destination, please follow the instructions below: Illustrated in the image below is an example of a flow that is triggered via a REST gateway to post a fil…

---

## [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 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 add a return limit in Sharepoint's API URL](https://community.synatic.com/t/how-to-add-a-return-limit-in-sharepoints-api-url/224)

<div class="topic-metadata">

**Author:** [@navessa](https://community.synatic.com/u/navessa)\
**Replies:** 0\
**Last updated:** [May 11, 2022, 1:59pm UTC](https://community.synatic.com/t/how-to-add-a-return-limit-in-sharepoints-api-url/224 "2022-05-11T13:59:50Z")

</div>

The default return limit for Sharepoint’s API is 100 records. In order to set a higher return limit, you need to add “ ?$top=1000 ” in your API URL as highlighted in the below image. It will return the records in batche…

---

## [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.
