Teams
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the organization.
1Specifies 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.
The value that will be used to sort returned entities by.
The value of entities you want to skip before getting entities you need.
The sorting order. It accepts the ascending and descending direction specifiers.
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.
Successful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The name of the team.
The ID of the organization.
The maximum number of operations allowed for the team.
Successful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
22Specifies 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.
{"value":["id","name","organizationId","activeScenarios","activeApps","operations","transfer","centicredits","operationsLimit","transferLimit","consumedOperations","consumedTransfer","isPaused","consumedCenticredits"]}Successful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
22Set this parameter to true to confirm the team deletion. Otherwise, the API call returns an error and the team is not deleted.
trueSuccessful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
22Successful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
22Number representing the type of the custom variable. The mapping of typeId and variable types is as follows:
- 1:
number, - 2:
string, - 3:
boolean, - 4:
datein ISO 8601 compliant formatYYYY-MM-DDTHH:mm:ss.sssZ. For example:1998-03-06T12:31:00.000Z.
Value assigned to the custom variable.
The name of the variable. You can use letters, digits, $ and _ characters in the custom variable name.
Successful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
22The name of the custom variable.
userIDSet to true to confirm deleting the custom variable. Otherwise the API call fails with the error IM004 (406).
trueSuccessful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
22The name of the custom variable.
userIDNumber representing the type of the custom variable. The mapping of typeId and variable types is as follows:
- 1:
number, - 2:
string, - 3:
boolean, - 4:
datein ISO 8601 compliant formatYYYY-MM-DDTHH:mm:ss.sssZ. For example:1998-03-06T12:31:00.000Z.
Value assigned to the custom variable.
Successful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
22The name of the custom variable.
userIDSuccessful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
22When set to true, the endpoint will calculate and return usage data based on the organization's timezone instead of the user's local timezone.
trueSuccessfully retrieved usage data
Successfully retrieved usage data
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
Successful response
Successful response
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
ID of the account used for AI mapping
Name of the AI model used for mapping
The builtin tier for AI mapping (small, medium, large)
ID of the account used for AI toolkit
Name of the AI model used for toolkit
The builtin tier for AI toolkit (small, medium, large)
Successful response
Successful response
Get feature controls of an organization which the team belongs to
Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.
If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.
The ID of the team.
11The feature control name.
Make AI ToolsSpecifies 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.
Successfully retrieved feature controls
Successfully retrieved feature controls
Last updated

