For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organizations

Organizations are main containers that contain all teams, scenarios, and users. The API endpoints discussed further allow you to manage organizations. Read more about organizations.

List user organizations

get
/organizations

Retrieves a collection of all organizations, in which the user has membership. The response contains information about the organization name, organizationId and timezoneId. You can get more data about the user organizations with specifying the cols[] query parameter.

However, the values for parameters license, serviceName and isPaused are returned only for organizations in your current Make zone.

Returned organizations are sorted by the organization name in ascending order by default. You can specify sorting order with the query parameter pg[sortBy].

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Query parameters
zonestringOptional

The URL of your Make instance domain.

Example: eu1.make.com
externalIdstringOptional

Make White Label product instances use the externalId parameter for security reasons. This parameter has null value in the public Make Cloud instance.

Example: {"value":"TESTORG003"}
pg[sortBy]stringOptional

The value that will be used to sort returned entities by.

pg[offset]integerOptional

The value of entities you want to skip before getting entities you need.

pg[sortDir]string · enumOptional

The sorting order. It accepts the ascending and descending direction specifiers.

Possible values:
pg[limit]integerOptional

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

Successful response

application/json
get/organizations
200

Successful response

Create an organization

post
/organizations

Create a new organization using the data sent in the request body. Successful response contains all information about the created organization.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Body
namestringRequired

The name of the organization. The name may contain only letters, numbers, spaces, and the following special characters: ', -, ., (, ), *, +, ,, @, _, /. The name must not start or end with a space.

regionIdintegerRequired

ID of the Make region instance associated with the organization. Get the list of Make regions with the API call GET /enums/imt-regions.

timezoneIdintegerRequired

The ID of the timezone associated with the organization. Get the list of the timezone IDs with the API call GET /enums/timezones.

countryIdintegerRequired

The ID of the country associated with the organization. Get the list of the country IDs with the API call GET /enums/countries.

Responses
200

Successful response

application/json
post/organizations
200

Successful response

Invitation detail

get
/organizations/invitation
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Query parameters
hashstringRequiredExample: bf1effe1-bc9d-4ab3-9414-9c3b66175305
Responses
200

Successful response

application/json
get/organizations/invitation
200

Successful response

Accept invitation

post
/organizations/accept-invitation
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Body
hashstringRequired
Responses
200

Successful response

application/json
post/organizations/accept-invitation
200

Successful response

Get organization details

get
/organizations/{organizationId}

Retrieves detail information of the organization with the specified organizationId.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Query parameters
waitbooleanOptional

Set this parameter to true if you are using the API call GET /organizations/{organizationId} shortly after creating the organization. The API call will first check synchronization of the Make backend and your Make zone data. If you don't use this argument, the API call might fail with an error due to unfinished data synchronization. The default value of this argument is false.

Example: true
Responses
200

Successful response

application/json
get/organizations/{organizationId}
200

Successful response

Delete an organization

delete
/organizations/{organizationId}

Deletes the organization with the specified organizationId. Make also deletes all the teams in the organization. You can only delete organizations that are associated with your current Make zone. Your current Make zone is specified in the API call URL. Currently, it is either:

  • eu1.make.com

  • us1.make.com

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Query parameters
confirmedbooleanOptional

Set to true to confirm the organization deletion. Otherwise, if the organization has active scenarios, Make won't delete the organization and the API call returns an error.

Example: true
Responses
200

Successful response

application/json
organizationintegerOptional
delete/organizations/{organizationId}
200

Successful response

Update organization information

patch
/organizations/{organizationId}

Updates the organization data with the values in the request body. If you don't use a parameter in the request body, Make won't change its value. You can update organization name, timezone, and country with the name, timezoneId, and countryId parameters.

Check the available values for the timezoneId and countryId parameters with the API calls GET /enums/timezones and GET /enums/countries.

The request response returns all organization data.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Body
namestringOptional

The new name of the organization. The name may contain only letters, numbers, spaces, and the following special characters: ', -, ., (, ), *, +, ,, @, _, /. The name must not start or end with a space.

countryIdintegerOptional

The ID of the country associated with the organization. Get the list of the country IDs with the API call GET /enums/countries.

timezoneIdintegerOptional

The ID of the timezone associated with the organization. Get the timezoneId values with the API call GET /enums/timezones.

Responses
200

Successful response

application/json
patch/organizations/{organizationId}
200

Successful response

Get a list of custom apps

get
/organizations/{organizationId}/apps

Get list of custom apps associated with the users in the organization. The request response contains information of both published and unpublished custom apps. The custom app name is suffixed with a random text string.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Responses
200

Successful response

application/json
get/organizations/{organizationId}/apps
200

Successful response

Get list of past payments

get
/organizations/{organizationId}/payments
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired
Query parameters
pg[sortBy]stringOptional

The value that will be used to sort returned entities by.

pg[offset]integerOptional

The value of entities you want to skip before getting entities you need.

pg[sortDir]string · enumOptional

The sorting order. It accepts the ascending and descending direction specifiers.

Possible values:
pg[limit]integerOptional

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

Successful response

application/json
get/organizations/{organizationId}/payments
200

Successful response

Get detail of an active subscription

get
/organizations/{organizationId}/subscription
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired
Responses
200

Successful response

application/json
pauseStartsAtstring · date-time · nullableOptional

When the pause becomes effective (end of the current paid period). Null when not paused.

pauseEndsAtstring · date-time · nullableOptional

Scheduled auto-resume date. Null when not paused.

isSubscriptionPausedbooleanOptional

True while the pause is in effect (subscription.pause_applied is true).

get/organizations/{organizationId}/subscription
200

Successful response

Create a new subscription

post
/organizations/{organizationId}/subscription
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired
Body
priceIdnumberRequired
couponCodestringOptional
Responses
200

Successful response

application/json
sessionIdnumberOptional
urlstringOptional
subscriptionIdnumberOptional
post/organizations/{organizationId}/subscription
200

Successful response

Cancel the active subscription

delete
/organizations/{organizationId}/subscription
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired
Responses
200

Successful response

application/json
okintegerOptional
delete/organizations/{organizationId}/subscription
200

Successful response

Change subscription

patch
/organizations/{organizationId}/subscription
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired
Body
priceIdnumberRequired
Responses
200

Successful response

application/json
okintegerOptional
patch/organizations/{organizationId}/subscription
200

Successful response

Pause the active subscription

post
/organizations/{organizationId}/subscription/pause

Schedules a pause for the active monthly self-service subscription. The pause becomes effective at the end of the current paid period and is automatically resumed on resumeAt. While paused the organization is treated as unlicensed (0 credits) and Stripe collection is suspended.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired
Body
resumeAtstring · date-timeRequired

Date when the subscription should automatically resume. Must be after the current period end and within 12 months.

Responses
200

Successful response

application/json
okintegerOptional
post/organizations/{organizationId}/subscription/pause
200

Successful response

Resume the subscription (cancel scheduled pause or resume now)

post
/organizations/{organizationId}/subscription/unpause

Ends the pause for the subscription. If the pause is still scheduled (current period not yet ended) it is simply cancelled — no charge, no billing reset. If the pause is in effect, the subscription is resumed immediately, billing anchor is reset to now and a fresh period is charged.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired
Responses
200

Successful response

application/json
okintegerOptional
post/organizations/{organizationId}/subscription/unpause
200

Successful response

List payment method types

get
/organizations/{organizationId}/subscription/payment-method-types

Returns a list of available payment method types for the organization's subscription.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Responses
200

Successful response

application/json
get/organizations/{organizationId}/subscription/payment-method-types
200

Successful response

List payment methods

get
/organizations/{organizationId}/subscription/payment-methods

Returns a list of payment methods for the organization's subscription.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Responses
200

Successful response

application/json
get/organizations/{organizationId}/subscription/payment-methods
200

Successful response

Delete a payment method

delete
/organizations/{organizationId}/subscription/payment-methods/{paymentMethodId}

Deletes a payment method from the organization's subscription.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

paymentMethodIdstringRequired

The ID of the payment method.

Responses
200

Successful response

application/json
okintegerOptionalExample: 1
delete/organizations/{organizationId}/subscription/payment-methods/{paymentMethodId}
200

Successful response

Set default payment method

patch
/organizations/{organizationId}/subscription/payment-methods/{paymentMethodId}/default

Sets a payment method as the default for the organization's subscription.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

paymentMethodIdstringRequired

The ID of the payment method.

Body
targetstring · enumOptional

What to set as default. Defaults to 'both'. 'extras' and 'both' throw 400 if the payment method is not immediate. 'subscription' sets default for subscription only.

Possible values:
Responses
200

Successful response

application/json
paymentMethodIdstringOptional
paymentMethodTypestringOptional
isDefaultForSubscriptionbooleanOptional
isDefaultForExtrasbooleanOptional
patch/organizations/{organizationId}/subscription/payment-methods/{paymentMethodId}/default
200

Successful response

Sets Free plan subscription

post
/organizations/{organizationId}/subscription-free
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired
Query parameters
confirmedbooleanOptional
Responses
200

Successful response

application/json
customerIdintegerOptional
subscriptionIdintegerOptional
post/organizations/{organizationId}/subscription-free
200

Successful response

Get universal discount

get
/organizations/{organizationId}/universal-discount

Returns the current universal discount (active or dormant) for the organization. The user must have the 'payment edit' organization permission or the 'organization view' admin permission.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 10
Responses
200

Successful response

application/json
get/organizations/{organizationId}/universal-discount
200

Successful response

Claim cancellation offer

post
/organizations/{organizationId}/universal-discount/claim-cancellation-offer

Claims a cancellation offer discount for the organization. The user must have the 'payment edit' permission on the organization. The organization must be eligible (no existing universal discount, no active coupon/promo).

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdinteger · min: 1Required

The ID of the organization.

Example: 10
Responses
200

Successful response

application/json
okintegerOptionalExample: 1
post/organizations/{organizationId}/universal-discount/claim-cancellation-offer
200

Successful response

Redeem universal discount on current plan

post
/organizations/{organizationId}/universal-discount/redeem

Activates a dormant universal discount on the user's current subscription. The current price must be eligible and no other discount can be active.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 10
Body
universalDiscountIdintegerRequired

The ID of the dormant universal discount to redeem

Example: 42
Responses
200

Successful response

application/json
okintegerOptionalExample: 1
post/organizations/{organizationId}/universal-discount/redeem
200

Successful response

Invite a user to the organization

post
/organizations/{organizationId}/invite

Invite a user to the organization. To automatically add the user to teams, specify IDs of the teams. The user gets the team role member. You can change the user team role with the API call POST /users/{userId}/user-team-roles/{teamId}.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Body
usersRoleIdintegerRequired

The ID of the user organization role assigned to the invited user. Get list of user role IDs from the API call GET /users/roles.

emailstring · emailRequired

The user registration email.

namestringRequired

The user name visible in the team and organization interface. The name may contain only letters, numbers, spaces, and the following special characters: ', -, ., (, ), *, +, ,, @, _, /. The name must not start or end with a space.

notestringOptional

Note added to the invitation.

teamsIdinteger[]Optional

The list of team IDs to which the invited user will be assigned. The invited user will receive the team role member.

Responses
200

Successful response

application/json
post/organizations/{organizationId}/invite
200

Successful response

List organization variables

get
/organizations/{organizationId}/variables

Retrieves the collection of organization variables. The response contains all organization variables if your account has the custom variables feature available. Otherwise, the response contains only Make system variables.

Check availability of the custom variables feature with the API call GET /organizations/{organizationId}. If the response contains "customVariables": true pair in the license object then you have access to the custom variables feature.

Refer to the Make pricing page for Make pricing plans overview.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Responses
200

Successful response

application/json
get/organizations/{organizationId}/variables
200

Successful response

Create organization variable

post
/organizations/{organizationId}/variables

Creates new organization variable. You can check the availability of the custom variables feature with the API call GET /organizations/{organizationId}. If the response contains "customVariables": true pair in the license object then you have access to the custom variables feature.

A successful response contains all information about the new variable. If you don't have the custom variables feature available then the API call returns the error 404.

Refer to the Make pricing page for Make pricing plans overview.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Body
typeIdnumberOptional

Number 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 format YYYY-MM-DDTHH:mm:ss.sssZ. For example: 1998-03-06T12:31:00.000Z.
valueone ofOptional

Value assigned to the custom variable.

stringOptional
or
booleanOptional
or
numberOptional
or
or
namestringOptional

The name of the variable. You can use letters, digits, $ and _ characters in the custom variable name.

Responses
200

Successful response

application/json
post/organizations/{organizationId}/variables
200

Successful response

Delete organization variable

delete
/organizations/{organizationId}/variables/{variableName}

Deletes organization variable.

If you don't have the custom variables feature available then the API call returns the error 404. Check the availability of the custom variables feature with the API call GET /organizations/{organizationId}. If the response contains "customVariables": true pair in the license object then you have access to the custom variables feature.

Refer to the Make pricing page for Make pricing plans overview.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
variableNamestringRequired

The name of the custom variable.

Example: userID
Query parameters
confirmedbooleanOptional

Set to true to confirm deleting the custom variable. Otherwise the API call fails with the error IM004 (406).

Example: true
Responses
200

Successful response

application/json
okintegerOptional
delete/organizations/{organizationId}/variables/{variableName}
200

Successful response

Update organization variable

patch
/organizations/{organizationId}/variables/{variableName}

Updates custom organization variable with the specified variable name. Only parameters specified in the request body are updated.

You can check the availability of the custom variables feature with the API call GET /organizations/{organizationId}. If the response contains "customVariables": true pair in the license object then you have access to the custom variables feature.

A successful response contains all information about the updated variable. If you don't have the custom variables feature available then the API call returns the error 404.

Refer to the Make pricing page for the Make pricing plans overview.

Update the variable typeId accordingly when you are updating the variable value. Make checks whether the variable type and value match in the request body. There is no check for incorrect variable type when you update only variable value and vice versa.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
variableNamestringRequired

The name of the custom variable.

Example: userID
Body
typeIdnumberOptional

Number 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 format YYYY-MM-DDTHH:mm:ss.sssZ. For example: 1998-03-06T12:31:00.000Z.
valueone ofOptional

Value assigned to the custom variable.

stringOptional
or
booleanOptional
or
numberOptional
or
or
Responses
200

Successful response

application/json
patch/organizations/{organizationId}/variables/{variableName}
200

Successful response

History of custom variable updates

get
/organizations/{organizationId}/variables/{variableName}/history

Gets the history of updates of the specified custom variable. The response contains the ID value of the variable history entry and a diffObject. The diffObject contains:

  • the original value,

  • the new value,

  • the timestamp of the update,

  • the author of the update.

If the variable doesn't have any updates, the diffObject contains the current value of the variable instead of the original and new values.

The update history entries are sorted from newest to latest.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
variableNamestringRequired

The name of the custom variable.

Example: userID
Responses
200

Successful response

application/json
get/organizations/{organizationId}/variables/{variableName}/history
200

Successful response

Get organization usage

get
/organizations/{organizationId}/usage

Retrieves a list of daily centicredits, operations, and data transfer usage across all scenarios within all teams in the specified organization for the past 30 days.

By default, the endpoint uses the timezone of the user making the API call to define the start and end of each day in the 30-day timeframe.

To use the organization's timezone instead, set the organizationTimezone parameter to true. This ensures that the daily aggregates align with the organization's operational hours. This is especially useful for scenarios where aggregated data needs to align with the organization's operational hours.

For instance, a remote data analyst in India working for a Czech company can set organizationTimezone=true to ensure the usage data reflects the company's timezone, providing more relevant and accurate insights for organizational reporting and analysis.

For more information on timezones in Make, please refer to our Help Center article.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Query parameters
organizationTimezonebooleanOptional

When set to true, the endpoint will calculate and return usage data based on the organization's timezone instead of the user's local timezone.

Example: true
Responses
200

Successfully retrieved usage data

application/json
get/organizations/{organizationId}/usage
200

Successfully retrieved usage data

Get organization feature controls

get
/organizations/{organizationId}/feature-controls

Retrieves all feature controls for the specified organization. Response order of the feature controls is by descending ID.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Query parameters
featureControlNamestringOptional

The feature control name.

Example: Make AI Tools
Responses
200

Successfully retrieved feature controls

application/json
enableAllControlFeaturesbooleanOptional
get/organizations/{organizationId}/feature-controls
200

Successfully retrieved feature controls

Patch organization feature controls

patch
/organizations/{organizationId}/feature-controls

Enable or disable feature control for the specified organization.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Body
idintegerOptional

The ID of the feature control.

enabledbooleanOptional

Indicates whether the feature control is enabled (true) or disabled (false).

Responses
200

Successful response

application/json
patch/organizations/{organizationId}/feature-controls
200

Successful response

Set TFA enforcement for an organization

patch
/organizations/{organizationId}/tfa-enforcement

Enables or disables two-factor authentication (TFA) enforcement for the specified organization.

When TFA enforcement is enabled, all users in the organization are required to have two-factor authentication configured. Users who do. not have TFA enabled will be automatically logged out.

Note: This endpoint is available only for organizations with a plan that supports TFA enforcement.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Body
enablebooleanRequired

Set to true to enable TFA enforcement for the organization, or false to disable it.

Responses
200

Successful response

application/json
patch/organizations/{organizationId}/tfa-enforcement

Get the organization's private-spaces settings

get
/organizations/{organizationId}/private-spaces-settings

Returns the private-spaces settings for the organization.

When the organization has no private-spaces settings configured yet, defaults are returned:

  • privateSpacesAutoCreationEnabled defaults to false

  • defaultOperationsLimit defaults to 1000

  • addAdminsAsObservers defaults to false

Once configured, the stored value is returned as-is — including an explicit null, which means unlimited operations (distinct from the never-configured default of 1000).

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Responses
200

Successful response

application/json
get/organizations/{organizationId}/private-spaces-settings

Update the organization's private-spaces settings

patch
/organizations/{organizationId}/private-spaces-settings

Updates the organization's private-spaces settings. All body fields are optional — only the keys provided are written.

Confirmation requirement

The ?confirmed=true query parameter is required when the request includes any of these bulk operations, otherwise the endpoint responds with IM004:

  • privateSpacesAutoCreationEnabled: truebulk-creates a private space for every eligible organization member (those holding the personal team own view permission) that does not already own one.

  • privateSpacesAutoCreationEnabled: falsealso deletes every existing private-space team in the organization.

  • addAdminsAsObservers: true / falsereconciles every existing private-space team: enabling adds org admins/owner as Team Observer; disabling removes those implicit observers.

  • bulkUpdateExistingLimits: true — overwrites limits.operations on every existing private-space team in the organization to match the defaultOperationsLimit, and re-evaluates each team's pause state. defaultOperationsLimit must be provided in the same request when bulkUpdateExistingLimits is true (a number, or null for unlimited), otherwise the request is rejected with IM005. This ensures the value applied org-wide is stated explicitly rather than implicitly inherited from the org's currently stored setting.

Changing defaultOperationsLimit alone (to any value, including null / 0 / lower) only affects future creations and does NOT require confirmation.

License requirement

Enabling addAdminsAsObservers requires the organization to hold the privateSpacesObservability license parameter. Without it, the request is rejected with SC402.

Owner-only field

addAdminsAsObservers can be changed only by the organization owner. Other organization admins may update the remaining settings on this endpoint, but a request that includes addAdminsAsObservers (either true or false) from a non-owner is rejected with IM002.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization.

Example: 11
Query parameters
confirmedbooleanOptional

Required when enabling/disabling auto-creation, toggling admin observers, or bulk-updating existing limits.

Example: true
Body
privateSpacesAutoCreationEnabledbooleanOptional

When true, new members of the organization automatically get a private space.

defaultOperationsLimitinteger · nullableOptional

Default operations limit applied when a private space is auto-created. Pass null to set unlimited operations.

bulkUpdateExistingLimitsbooleanOptional

When true, applies defaultOperationsLimit to every existing private-space team in the organization. Requires defaultOperationsLimit to be provided in the same request (rejected with IM005 otherwise).

addAdminsAsObserversbooleanOptional

When true, organization admins/owner are added as Team Observer to private spaces (and to all existing ones); when false, those implicit observers are removed. Settable by the organization owner only — a non-owner request including this field is rejected with IM002. Enabling requires the privateSpacesObservability license (rejected with SC402 otherwise).

Responses
200

Successful response

application/json
bulkCreatedTeamIdsinteger[]Optional

IDs of private-space teams created by enabling auto-creation. Empty unless privateSpacesAutoCreationEnabled was set to true.

bulkUpdatedTeamIdsinteger[]Optional

IDs of private-space teams whose limits were overwritten by the bulk update. Empty unless bulkUpdateExistingLimits was set.

bulkDeletedTeamIdsinteger[]Optional

IDs of private-space teams that were deleted as part of disabling auto-creation. Empty unless privateSpacesAutoCreationEnabled was set to false.

observersAddedTeamIdsinteger[]Optional

IDs of private-space teams that gained admin Team Observer memberships. Empty unless addAdminsAsObservers was set to true.

observersRemovedTeamIdsinteger[]Optional

IDs of private-space teams that had admin Team Observer memberships removed. Empty unless addAdminsAsObservers was set to false.

patch/organizations/{organizationId}/private-spaces-settings

Check team permission within organization

get
/organizations/{organizationId}/check-team-permission

Checks if the current user has a specific team (company) permission on any team within the specified organization. Returns hasPermission: true if the user has the permission on at least one team in the organization, otherwise returns hasPermission: false.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

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.

Path parameters
organizationIdintegerRequired

The ID of the organization to check permissions within.

Example: 123
Query parameters
teamPermissionstringRequired

The name of the team permission to check. This should be a valid company/team permission name (e.g., 'scenario add', 'scenario view', 'team view', 'connection add').

Example: scenario add
Responses
200

Successfully checked permission

application/json
hasPermissionbooleanOptional

Indicates whether the user has the specified permission on at least one team within the organization.

get/organizations/{organizationId}/check-team-permission

Last updated