Create and manage APIs using API builder

• Manage permission or Administrator role — You must have the Manage permission on the integration or the Administrator role on the account. See Manage account and integration permissions for details.

You can start a new API from any of these locations:

• From the Home page, select Create > API.

  

• From any page, select Build > APIs.

  

  • If you haven't created an API, select Create API.

    

  • If you've already created an API, select Create API above the list.

    

1. Select Create API from any of the locations in Where to create an API.

2. Under How would you like to build the API?, select API builder or JavaScript.

   Note

   This article covers the API builder. To create an API using JavaScript, see Create a JavaScript API.

3. Enter a Name for your API. For example, "Get a pet."
4. (Optional) Enter a Description.
5. Enter the Version. The version defaults to v1, but you can change it. The API's URI includes the version as: https://api.integrator.io/apis/<version>.
6. Under Integration, select Create new integration or Add to existing integration. If you add your API to an existing integration, select it in Select integration.
7. Select Save & next to create your API.

Select Actions in the upper-right corner of API builder to open these actions:

Note: The log mode controls what request history and execution logs capture for your API. For how to view and use logs, see View API request and execution logs in API builder and Test and debug your API using API builder.

You can organize the APIs in an integration into API groups. API groups are available only in an integration.

To create an API group:

1. Go to your integration, and then select the APIs tab.
2. Select Create > Create API group.
3. Enter a Group name.
4. (Optional) In APIs, select the APIs to add to the group.
5. Select Save.

The API groups panel lists your groups and the Unassigned group, which holds APIs that aren't in a group. To create an API in a group, select the group, and then select Create > API. To change or delete a group, select the group, and then select Edit API group or Delete API group next to Create. Deleting a group doesn't delete its APIs. They move to Unassigned.

The Advanced section of API settings controls how long an API waits for a request to finish, whether it returns results in pages, what it does when a connection it uses is offline, and whether it checks requests and responses against your schemas. These settings apply only to the API you're editing.

To change advanced settings:

1. Go to Build > APIs, select API builder, and then select your API.
2. Open API settings, and then go to the Advanced section.
3. Change the settings you need. Each setting is described in the following table and sections.
4. Select Save.

{
  "data": [...],
  "pagination": {
    "has_more": true,
    "next_cursor": "..."
  }
}

The APIs page lists the APIs in your account. Use it to find an API, check its status, and open, change, or remove it. To open the page, select Build > APIs. The API builder list shows APIs built in API builder, and the JavaScript list shows JavaScript APIs. The API builder list in an integration shows the same list for the APIs in that integration.

Actions

Select Actions on an API's row to open its actions. API builder has its own Actions menu with a different set of actions. See Build an API.

Action	Description
Edit API	Opens the API in API builder.
View request logs	Opens the API's request logs. See View API request and execution logs in API builder.
View audit log	Opens the API's audit log. See audit logs.
Push to APIM or View in APIM	API Management only. Pushes the API to your API Management console so you can add configurations and publish it. After you push an API, an APIM label appears next to it in the list. See Push your API to your API console.
Download OAS	Downloads the OpenAPI specification (OAS) that integrator.io generates for the API. See Download the OpenAPI spec.
Download API	Downloads the API's configuration so you can upload it to a different environment or account.
Copy cURL	Copies a cURL command that invokes the API. Available only after you configure your API request.
Add to MCP server	Adds the API to a new or existing MCP server so AI agents or external tools can use it. Enter a Name and Description, select Create new MCP or Add to existing MCP, and then select Add to MCP server. See MCP servers.
Clone API	Clones the API into another integration or environment. See Clone an API.
Move to other integration	Moves the API to a new or existing integration. Select Create new integration or Add to existing integration, select the integration if you're adding to an existing one, and then select Save & next.
Used by	Lists the resources that use this API. The list shows each resource's Name and Type.
Delete API	Sends the API to the Recycle bin for 30 days or until your data retention policy purges it. See Delete an API.

For example, Copy cURL copies a command like this one:

curl -X GET "https://api.integrator.io/apis/v1/pets/sampleid?microchip_id=true" \
  -H "Authorization: Bearer ****"

You can clone an API for versioning, testing, repurposing, or promotion to a new environment.

To clone an API:

1. Go to Build > APIs, and then select API builder.

   

2. From the API builder list view, find the API you'd like to clone and select Actions > Clone API. The Clone API page opens.

   Or:

   From the API builder, select Actions > Clone API. The Clone API page opens.

   

   API builder list view

   

   API builder

3. Name — Enter a unique name for your cloned API.

   
4. Description (optional) — Enter a description for your cloned API.
5. Environment — Select an environment to clone your API into. This option appears only for accounts with multiple environments. See Use multiple environments.
6. Integration — Select the integration to clone your API into.

7. Version — Enter a version for your cloned API.

   Note

   API builder requires a unique combination of HTTP method, version, and relative URI in each environment when you use multiple environments. With the standard Sandbox and Production setup, the combination must be unique across both environments, because they share API tokens.

8. Review your API resources. The APIs, Lookups, and Connections sections list the resources that are cloned. Your resources (APIs, lookups, and imports), branching, filters, and transformations are all cloned.

   
9. Select Clone API to continue.
10. The cloned API opens in API builder. If it uses connections, review them on the Connections tab.

After an API is deleted, it's placed in the Recycle bin and purged according to your organization's data retention period.

If the API has been pushed to the API Management console, deleting it may affect existing API consumers relying on it. You must update the API and the OpenAPI specification in the API Management console.

Delete API is available only when the API is off. To turn an API off, use Off / On in the list or select Actions > Disable API in API builder.

To delete an API from the API builder list view:

1. Go to Build > APIs, and then select API builder.
2. Find your API in the list and select Actions > Delete API.

To delete an API from the API builder:

1. Go to Build > APIs, select API builder, and then select the API you want to delete.
2. In the API builder, select Actions > Delete API.

You can invoke an API using a third-party tool, such as Postman, with cURL and an API token. You never need to include any form of authentication in custom headers. All APIs created in the Celigo platform automatically include token authentication and require an API token to be invoked externally. You can use other authentication methods, such as JWT or OAuth 2.0, with API Management, but you must manually update the OpenAPI schema in the API Management console.

To copy the cURL command:

1. Go to Build > APIs, and then select API builder.

2. Find your API in the list and select Actions > Copy cURL.

   

To copy only the invoke URL, open your API in API builder, and then select Actions > Copy Invoke URL.

To generate an API token, see Create and manage API and Personal Access tokens. You can create a custom API token that only applies to specific APIs or a token that has full access to your Celigo platform account.

The following limits and requirements apply to requests and responses:

• Manage account and integration permissions
• Build your API – Basics
• Introduction to Celigo tools
• Use multiple environments
• Clone an integration for Integration Lifecycle Management (ILM)
• Integration Lifecycle Management (ILM) overview
• Developing with integration lifecycle management
• Pull changes from one integration to another
• Create and manage API and Personal Access tokens
• Fix an offline connection
• View API request and execution logs in API builder
• Troubleshoot APIs
• Validate API requests and responses in API builder