Find us at our new Help Center where we've combined our documentation and knowledgebase articles in one easy-to-search location.
We aren't updating the Developer Portal anymore, except for the Element Docs — all updates happen in the Help Center. We're retiring the Developer Portal as you know it in:
After completing the basic element information, configure the Properties on the Element Builder Setup page. Properties include the Base URL, pagination information, and header formats.
To complete the Properties section:
In Accept Header to configure the response body media type that you expect to receive from the API provider.
Click Save.
Parameter | Description | Required |
---|---|---|
Base URL | Endpoints are appended to the base URL. So, with an endpoint like https://api.example.com/v1/users?role=admin&status=active , the base URL is https://api.example.com/v1/ . Many API providers explicitly state the base URL, but in some cases you can find it by looking at examples in the API documentation. |
Y |
Pagination Max | The maximum number of records the API provider returns in a response. | Y |
Pagination Type | How the API provider provides pages of data. Find the pagination types in a Pagination section of the API documentation. | Y |
Page starts with n — Pagination begins with either 1 or 0. | ||
Offset — A numeric offset identifies the first page. | ||
Cursor — A unique key element identifies the first page entry | ||
Content-Type Header | The supported request media type. | Y |
Accept Header | The supported response media type. | Y |
Continue to the next step, Element Builder Authentication Setup.