### Example GET Request for Data Stores Source: https://developers.make.com/api-documentation/getting-started/resources This is a basic example of a GET request to retrieve a list of data stores. ```http GET /data-stores ``` -------------------------------- ### Example GET Request with Query Parameters Source: https://developers.make.com/api-documentation/getting-started/resources This example shows how to query data stores with specific parameters like team ID and pagination offset. Note the URL encoding for square brackets in the query parameter. ```http /data-stores?teamId=123&pg%5Boffset%5D=10 ``` -------------------------------- ### Dynamic Documentation Query Example Source: https://developers.make.com/api-documentation/getting-started/making-your-first-api-request Perform an HTTP GET request with an 'ask' query parameter to dynamically query the documentation. ```http GET https://developers.make.com/api-documentation/getting-started/making-your-first-api-request.md?ask= ``` -------------------------------- ### Example GET Request for Specific Data Store Source: https://developers.make.com/api-documentation/getting-started/resources This example demonstrates how to access a specific data store resource by including its ID in the URI path. ```http /data-stores/54 ``` -------------------------------- ### Example Make Zone URLs Source: https://developers.make.com/api-documentation/getting-started/api-structure Examples of different zone URLs for Make organizations. ```text https://eu1.make.com/ ``` ```text https://eu2.make.com/ ``` ```text https://eu1.make.celonis.com/ ``` ```text https://us1.make.com/ ``` ```text https://us2.make.com/ ``` ```text https://us1.make.celonis.com/ ``` -------------------------------- ### Example Dynamic Documentation Query Source: https://developers.make.com/api-documentation/getting-started/resources This example shows how to query the documentation dynamically by appending an 'ask' parameter with a natural language question to the page URL. ```http GET https://developers.make.com/api-documentation/getting-started/resources.md?ask= ``` -------------------------------- ### Example Make API URL Source: https://developers.make.com/api-documentation/getting-started/api-structure An example of a complete Make API URL for retrieving user information. ```text https://eu1.make.com/api/v2/users/me ``` -------------------------------- ### Example Make API Base URL Source: https://developers.make.com/api-documentation/getting-started/api-structure An example of a Make API base URL, which includes the zone URL and API version. ```text https://eu1.make.com/api/v2 ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://developers.make.com/api-documentation/api-reference/analytics Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic information. The question should be specific and self-contained. ```http GET https://developers.make.com/api-documentation/api-reference/analytics.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://developers.make.com/api-documentation/api-reference/users/roles Perform an HTTP GET request with the `ask` query parameter to get specific information or clarification not explicitly present on the page. ```http GET https://developers.make.com/api-documentation/api-reference/users/roles.md?ask= ``` -------------------------------- ### GET Source: https://developers.make.com/api-documentation/getting-started/http-methods Retrieves a resource representation without modifying it. Example: GET /scenarios returns all available Make scenarios. ```APIDOC ## GET /scenarios ### Description Retrieves a resource representation without modifying it. ### Method GET ### Endpoint /scenarios ### Response #### Success Response (200) - **scenarios** (array) - A list of available scenarios. ``` -------------------------------- ### Start Hook Learning Process Source: https://developers.make.com/api-documentation/api-reference/hooks Starts the process of learning the request body structure by a hook with a given ID. The data structure learning process also starts automatically when a new hook is created and stops once the data structure is determined. Use the `GET /hooks` API call to get the ID values of your webhooks. ```json { "openapi": "3.0.0", "info": { "title": "Web API v2 - Public ", "version": "1.0.0" }, "tags": [ { "name": "Hooks", "description": "Hooks refer to the webhooks and mailhooks available in the various apps in the Make interface. They notify you whenever a certain change occurs in the connected app or service, such as sending an HTTP request or an email. The following endpoints allow you to create and manage hooks." } ], "servers": [ { "url": "https://eu1.make.com/api/v2", "description": "EU1 production zone" }, { "url": "https://eu2.make.com/api/v2", "description": "EU2 production zone" }, { "url": "https://us1.make.com/api/v2", "description": "US1 production zone" }, { "url": "https://us2.make.com/api/v2", "description": "US2 production zone" }, { "url": "https://eu1.make.celonis.com/api/v2", "description": "Celonis EU1 production zone" }, { "url": "https://us1.make.celonis.com/api/v2", "description": "Celonis US1 production zone" } ], "security": [ { "token": [ "hooks:write" ] } ], "components": { "securitySchemes": { "token": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "Authorize the API call with your API token in the `Authorization` header with the value: `Token your-api-token`.\n\nIf you don't have an API token yet, please refer to the [\"Authentication\" section](/api-documentation/authentication) to learn how to create one.\n" } } }, "paths": { "/hooks/{hookId}/learn-start": { "post": { "tags": [ "Hooks" ], "summary": "Learn start", "description": "Starts the process of learning the request body structure by a hook with a given ID. When you send to the hook address a request with data in its body, you can use this endpoint to force the hook to start determining the payload data structure which will later be suggested in the scenario as the output of the hook. The data structure learning process also starts automatically when a new hook is created and stops once the data structure is determined. If you want to stop this process, you can use the [Learn stop](./post--hooks--hookid--learn-stop.md) endpoint.", "parameters": [ { "name": "hookId", "in": "path", "schema": { "type": "integer" }, "required": true, "description": "The ID of the webhook. Use the `GET /hooks` API call to get the ID values of your webhooks." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } } } } } } ``` -------------------------------- ### Query Documentation Dynamically Source: https://developers.make.com/api-documentation/troubleshooting Use this GET request to ask questions about the documentation. Include your specific question in the `ask` query parameter. The response will provide a direct answer with relevant excerpts and sources. ```http GET https://developers.make.com/api-documentation/troubleshooting.md?ask= ``` -------------------------------- ### Get Connection Section - OpenAPI Spec Source: https://developers.make.com/api-documentation/api-reference/sdk-apps/connections This OpenAPI 3.0.0 specification defines the GET endpoint for retrieving a specific section of an SDK App Connection. It includes details on parameters, responses, and available sections like api, parameters, scopes, scope, install, and installSpec. ```json { "openapi": "3.0.0", "info": { "title": "Web API v2 - Public ", "version": "1.0.0" }, "tags": [ { "name": "SDK Apps / Connections" } ], "servers": [ { "url": "https://eu1.make.com/api/v2", "description": "EU1 production zone" }, { "url": "https://eu2.make.com/api/v2", "description": "EU2 production zone" }, { "url": "https://us1.make.com/api/v2", "description": "US1 production zone" }, { "url": "https://us2.make.com/api/v2", "description": "US2 production zone" }, { "url": "https://eu1.make.celonis.com/api/v2", "description": "Celonis EU1 production zone" }, { "url": "https://us1.make.celonis.com/api/v2", "description": "Celonis US1 production zone" } ], "security": [ { "token": [ "sdk-apps:read" ] } ], "components": { "securitySchemes": { "token": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "Authorize the API call with your API token in the `Authorization` header with the value: `Token your-api-token`.\n\nIf you don't have an API token yet, please refer to the [\"Authentication\" section](/api-documentation/authentication) to learn how to create one.\n" } } }, "paths": { "/sdk/apps/connections/{SDK_connectionName}/{SDK_connectionSection}": { "get": { "tags": [ "SDK Apps / Connections" ], "summary": "Get Connection Section", "description": "Available sections: api, parameters, scopes, scope, install, installSpec
\n", "parameters": [ { "name": "SDK_connectionName", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "SDK_connectionSection", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "authorize": { "type": "object", "properties": { "qs": { "type": "object", "properties": { "scope": { "type": "string" }, "client_id": { "type": "string" }, "redirect_uri": { "type": "string" }, "response_type": { "type": "string" } } }, "url": { "type": "string", "format": "uri" }, "response": { "type": "object", "properties": { "temp": { "type": "object", "properties": { "code": { "type": "string" } } } } } } }, "token": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "body": { "type": "object", "properties": { "code": { "type": "string" }, "client_id": { "type": "string" }, "grant_type": { "type": "string" }, "redirect_uri": { "type": "string" }, "client_secret": { "type": "string" } } }, "type": { "type": "string" }, "method": { "type": "string" }, "response": { "type": "object", "properties": { "data": { "type": "object", "properties": { "accessToken": { "type": "string" } } } } }, "log": { "type": "object", "properties": { "sanitize": { "type": "array", "items": { "type": "string" } } } } } }, "info": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "headers": { "type": "object", "properties": { "authorization": { "type": "string" } } }, "response": { "type": "object", "properties": { "uid": { "type": "string" }, "metadata": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } } } } }, "log": { "type": "object", "properties": { "sanitize": { "type": "array", "items": { "type": "string" } } } } } }, "invalidate": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "headers": { "type": "object", "properties": { "authorization": { "type": "string" } } }, "log": { "type": "object", "properties": { "sanitize": { "type": "array", "items": { "type": "string" } } } } } } } } } } } } } } } } ``` -------------------------------- ### Get Connection Section Source: https://developers.make.com/api-documentation/api-reference/sdk-apps/connections Retrieves specific sections of information for an SDK application connection. Available sections include 'api', 'parameters', 'scopes', 'scope', 'install', and 'installSpec'. ```APIDOC ## GET /sdk/apps/connections/{SDK_connectionName}/{SDK_connectionSection} ### Description Retrieves a specific section of an SDK application connection's details. The available sections are: api, parameters, scopes, scope, install, installSpec. ### Method GET ### Endpoint /sdk/apps/connections/{SDK_connectionName}/{SDK_connectionSection} ### Parameters #### Path Parameters - **SDK_connectionName** (string) - Required - The name of the SDK connection. - **SDK_connectionSection** (string) - Required - The specific section of the connection to retrieve (e.g., 'api', 'parameters'). ### Responses #### Success Response (200) - **authorize** (object) - Details related to authorization, including query parameters and temporary codes. - **token** (object) - Information about token generation, including URL, request body, method, and response structure. - **info** (object) - General information about the connection, including URL and authorization headers. - **invalidate** (object) - Details for invalidating a connection, including URL and headers. ``` -------------------------------- ### cURL Request to List Data Stores Source: https://developers.make.com/api-documentation/getting-started/making-your-first-api-request Use cURL to send a GET request to the data stores endpoint, including authentication and query parameters. Note: The example token is for illustration only; generate your own. ```bash curl --location \ --request GET 'https://eu1.make.com/api/v2/data-stores?teamId=35&pg%5BsortDir%5D=asc' \ --header 'Content-Type: application/json' \ --header 'Authorization: Token 93dc8837-2911-4711-a766-59c1167a974d' ``` -------------------------------- ### Query Documentation Source: https://developers.make.com/api-documentation/api-reference/users/api-tokens Perform an HTTP GET request with the `ask` query parameter to query documentation dynamically. The question should be specific and self-contained. ```http GET https://developers.make.com/api-documentation/api-reference/users/api-tokens.md?ask= ``` -------------------------------- ### Get trigger details Source: https://developers.make.com/api-documentation/api-reference/scenarios Retrieves properties of a trigger included in a scenario with a given ID. A trigger is a module that is able to return bundles that were newly added or updated (depending on the settings) since the last run of the scenario. An example of a trigger is a hook. ```APIDOC ## Get trigger details ### Description Retrieves properties of a trigger included in a scenario with a given ID. A trigger is a module that is able to return bundles that were newly added or updated (depending on the settings) since the last run of the scenario. An example of a trigger is a hook. ### Method GET ### Endpoint /scenarios/{scenarioId}/triggers ### Parameters #### Path Parameters - **scenarioId** (integer) - Required - The ID of the scenario. You can get the `scenarioId` with the [List scenarios](/api-reference/scenarios/get--scenarios.md) API call. ### Responses #### Success Response (200) - **id** (integer) - **name** (string) - **udid** (string) - **scope** (string) - **queueCount** (integer) - **queueLimit** (integer) - **typeName** (string) - **type** (string) - **url** (uri) - **flags** (object) #### Response Example { "id": 12345, "name": "My Scenario Trigger", "udid": "abc-123-def-456", "scope": "public", "queueCount": 0, "queueLimit": 100, "typeName": "Webhook", "type": "webhook", "url": "https://hook.make.com/abc-123-def-456", "flags": {} } ``` -------------------------------- ### Querying Documentation with 'ask' Parameter Source: https://developers.make.com/api-documentation/getting-started/api-structure Perform an HTTP GET request with the 'ask' query parameter to dynamically query the documentation. ```http GET https://developers.make.com/api-documentation/getting-started/api-structure.md?ask= ``` -------------------------------- ### Example cURL Request for Creating a Data Store Source: https://developers.make.com/api-documentation/getting-started/resources This cURL command demonstrates how to create a data store using a POST request. It includes the endpoint, content type, authorization token, and the request body. ```bash curl -X POST https://eu1.make.dev/api/v2/data-stores \ --header 'Content-Type: application/json' \ --header 'Authorization: Token 93dc8837-2911-4711-a766-59c1167a974d' \ -d '{"name":"Customers","teamId":123,"datastructureId":1234,"maxSizeMB":1}' ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://developers.make.com/api-documentation/api-reference/templates/public Perform an HTTP GET request on the current page URL with the `ask` query parameter to ask a question about the documentation. The question should be specific and self-contained. Use this when the answer is not explicitly present, you need clarification, or want to retrieve related sections. ```http GET https://developers.make.com/api-documentation/api-reference/templates/public.md?ask= ``` -------------------------------- ### Query Documentation with GET Request Source: https://developers.make.com/api-documentation/api-reference/sdk-apps To get additional information not directly present on the page, perform an HTTP GET request to the page URL with the `ask` query parameter. The question should be specific and in natural language. ```http GET https://developers.make.com/api-documentation/api-reference/sdk-apps.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://developers.make.com/api-documentation/api-reference/cashier Perform an HTTP GET request with an 'ask' query parameter to dynamically query the documentation. This is useful for retrieving specific information not explicitly present or for clarification. ```http GET https://developers.make.com/api-documentation/api-reference/cashier.md?ask= ``` -------------------------------- ### Get scenario details Source: https://developers.make.com/api-documentation/api-reference/scenarios Retrieves all available properties of a scenario with a given ID. The returned details do not include a scenario blueprint. If you want to get a scenario blueprint, refer to the Get scenario blueprint endpoint. ```APIDOC ## Get scenario details ### Description Retrieves all available properties of a scenario with a given ID. The returned details do not include a scenario blueprint. If you want to get a scenario blueprint, refer to the [Get scenario blueprint](./blueprints/get--scenarios--scenarioid--blueprint.md) endpoint. ### Method GET ### Endpoint /scenarios/{scenarioId} ### Parameters #### Path Parameters - **scenarioId** (integer) - Required - The ID of the scenario. You can get the `scenarioId` with the [List scenarios](/api-reference/scenarios/get--scenarios.md) API call. #### Query Parameters - **cols[]** (array of strings) - Optional - Specifies columns that are returned in the response. Use the `cols[]` parameter for every column that you want to return in the response. For example `GET /endpoint?cols[]=key1&cols[]=key2` to get both `key1` and `key2` columns in the response. [Check the "Filtering" section for a full example.](/pagination-sorting-filtering/filtering.md) ### Responses #### Success Response (200) - **scenario** (object) - Contains scenario details. - **id** (integer) - **name** (string) - **teamId** (integer) - **hookId** (integer) - **devices** (array of objects) - **id** (integer) - **scope** (string) - **deviceId** (integer) - Deprecated - **deviceScope** (string) - Deprecated - **description** (string) - **folderId** (integer) - **isinvalid** (boolean) - **islinked** (boolean) - Deprecated - **isActive** (boolean) - **islocked** (boolean) - **isPaused** (boolean) - **usedPackages** (array of strings) - **lastEdit** (string, date-time) - **scheduling** (object) - **type** (string) - **interval** (integer) - **iswaiting** (boolean) - **dlqCount** (integer) - **createdByUser** (object) - **id** (integer) - **name** (string) - **email** (string) - **updatedByUser** (object) - **id** (integer) - **name** (string) - **email** (string) - **nextExec** (string, date-time) - **created** (string, date-time) - **scenarioVersion** (integer) - **moduleSequenceId** (integer) - **type** (string, enum: scenario, tool) ``` -------------------------------- ### Query Documentation with GET Request Source: https://developers.make.com/api-documentation/api-reference/devices/outgoings Perform an HTTP GET request to the current page URL, appending the `ask` query parameter with your question. Use this for information not explicitly present or for clarification. ```http GET https://developers.make.com/api-documentation/api-reference/devices/outgoings.md?ask= ``` -------------------------------- ### Get User Team Role Details Source: https://developers.make.com/api-documentation/api-reference/teams/user-team-roles Retrieves information about a user's role in a specific team using their userId and teamId. Use the `GET users/roles` API call to get all user role IDs. ```json { "openapi": "3.0.0", "info": { "title": "Web API v2 - Public ", "version": "1.0.0" }, "tags": [ { "name": "Teams / User team roles", "description": "User team roles define user permissions in the team. The endpoints discussed further retrieve information about user roles in the team. Use the `/users/{userId}/user-team-roles/{userId}` endpoint to manage user team roles. Check out the [overview of user team roles and the associated permissions](https://www.make.com/en/help/access-management/teams#managing-team-members)." } ], "servers": [ { "url": "https://eu1.make.com/api/v2", "description": "EU1 production zone" }, { "url": "https://eu2.make.com/api/v2", "description": "EU2 production zone" }, { "url": "https://us1.make.com/api/v2", "description": "US1 production zone" }, { "url": "https://us2.make.com/api/v2", "description": "US2 production zone" }, { "url": "https://eu1.make.celonis.com/api/v2", "description": "Celonis EU1 production zone" }, { "url": "https://us1.make.celonis.com/api/v2", "description": "Celonis US1 production zone" } ], "security": [ { "token": [ "teams:read" ] } ], "components": { "securitySchemes": { "token": { "type": "apiKey", "name": "Authorization", "in": "header", "description": "Authorize the API call with your API token in the `Authorization` header with the value: `Token your-api-token`.\n\nIf you don't have an API token yet, please refer to the [\"Authentication\" section](/api-documentation/authentication) to learn how to create one.\n" } } }, "paths": { "/teams/{teamId}/user-team-roles/{userId}": { "get": { "tags": [ "Teams / User team roles" ], "summary": "Get user team role details", "description": "Retrieves information about user role in a team with the specified `userId` and `teamId`. Get all user role IDs with the API call `GET users/roles`.", "parameters": [ { "name": "teamId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The ID of the team." }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true, "description": "The ID of the user." }, { "name": "cols", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Specifies columns that are returned in the response. Use the `cols[]` parameter for every column that you want to return in the response. For example `GET /endpoint?cols[]=key1&cols[]=key2` to get both `key1` and `key2` columns in the response.\n\n[Check the \"Filtering\" section for a full example.](/pagination-sorting-filtering/filtering.md)\n" }, { "name": "pg[sortBy]", "in": "query", "schema": { "type": "string" }, "description": "The value that will be used to sort returned entities by." }, { "name": "pg[offset]", "in": "query", "schema": { "type": "integer" }, "description": "The value of entities you want to skip before getting entities you need." }, { "name": "pg[sortDir]", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "description": "The sorting order. It accepts the ascending and descending direction specifiers." }, { "name": "pg[limit]", "in": "query", "schema": { "type": "integer" }, "description": "Sets the maximum number of results per page in the API call response. For example, `pg[limit]=100`. The default number varies with different API endpoints." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "userTeamRole": { "type": "object", "properties": { "usersRoleId": { "type": "integer" }, "userId": { "type": "integer" }, "teamId": { "type": "integer" }, "changeable": { "type": "boolean" }, "ssoPending": { "type": "boolean" } } } } } } } } } } } } } ``` -------------------------------- ### List custom property structure items Source: https://developers.make.com/api-documentation/api-reference/custom-properties/structure-items Gets the list of structure items in the specified custom properties structure. Use the API call `GET /custom-property-structures?{organizationId}` to get the ID of the custom property structure. ```APIDOC ## GET /custom-property-structures/{customPropertyStructureId}/custom-property-structure-items ### Description Gets the list of structure items in the specified custom properties structure. Use the API call `GET /custom-property-structures?{organizationId}` to get the ID of the custom property structure. ### Method GET ### Endpoint /custom-property-structures/{customPropertyStructureId}/custom-property-structure-items ### Parameters #### Path Parameters - **customPropertyStructureId** (integer) - Required - The ID of the custom property structure. Use the API call `GET /custom-property-structures?organizationId={organizationId}` to get the ID of a custom property structure. #### Query Parameters - **cols[]** (array[string]) - Optional - Specifies columns that are returned in the response. Use the `cols[]` parameter for every column that you want to return in the response. For example `GET /endpoint?cols[]=key1&cols[]=key2` to get both `key1` and `key2` columns in the response. [Check the "Filtering" section for a full example.](/pagination-sorting-filtering/filtering.md) - **pg[sortBy]** (string) - Optional - Specify the custom property item attribute. The custom property items in the response are sorted by the value of the attribute. - **pg[offset]** (integer) - Optional - The value of entities you want to skip before getting entities you need. - **pg[sortDir]** (string) - Optional - The sorting order. It accepts the ascending and descending direction specifiers. - **pg[limit]** (integer) - Optional - Sets the maximum number of results per page in the API call response. For example, `pg[limit]=100`. The default number varies with different API endpoints. ### Response #### Success Response (200) - **customPropertyStructureItems** (array[object]) - An array of custom property structure items. - **id** (integer) - **created** (string, format: date-time) - **belongers** (array[object]) - **belongerId** (integer) - **belongerType** (string) - **associatedTypes** (array[string]) - **pg** (object) - **last** (string) - **showLast** (boolean) - **sortBy** (string) - **sortDir** (string) - **limit** (integer) - **offset** (integer) ### Response Example { "customPropertyStructureItems": [ { "id": 123, "created": "2023-10-27T10:00:00Z", "belongers": [ { "belongerId": 456, "belongerType": "scenario", "associatedTypes": ["customProperty"] } ] } ], "pg": { "last": "someLastValue", "showLast": true, "sortBy": "id", "sortDir": "asc", "limit": 100, "offset": 0 } } ```