Admin > Organizations

The following endpoints allow you to inspect and manage organizations in the Make White Label product. You can also adjust operations and data transfer allowance and manage individual organizations access to Make White Label features.

List organizations

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/admin/organizations

Gets the list of all organizations in the Make White Label product instance. The response contains all available information about all organizations in the Make White Label product instance.

Use the id, name or externalId query parameters to limit the results to a specific organization or the cols[] parameter to get specific columns.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

idintegerOptional

The ID of the organization.

Example: {"value":5}

namestringOptional

The name of the organization.

externalIdstringOptional

Custom organization ID from a different system than Make White Label.

colsstring[]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.

Example: {"value":["id","name","license"]}

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

/admin/organizations

HTTPcURLJavaScriptPython

GET /api/v2/admin/organizations HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "organizations": [
    {
      "id": 7,
      "name": "API example",
      "timezoneId": 318,
      "countryId": 202,
      "license": {
        "dslimit": 40,
        "executionTime": 45,
        "fslimit": 1048576000,
        "iolimit": 10000,
        "dsslimit": 524288000,
        "interval": 1,
        "transfer": 1099511627776,
        "operations": 800000000,
        "gracePeriod": 0,
        "customVariables": true,
        "productManagement": "salesforce",
        "scenarioInputs": true,
        "restartPeriod": "1 month"
      },
      "serviceName": "default",
      "teams": [
        {
          "id": 6,
          "name": "My Team",
          "externalId": null
        }
      ],
      "isPaused": false,
      "zone": "white.label.example.com",
      "externalId": null,
      "scenarios": 2,
      "activeScenarios": 0,
      "deleted": false,
      "tfaEnforced": false
    },
    {
      "id": 5,
      "name": "new org",
      "timezoneId": 113,
      "countryId": 1,
      "license": {
        "dslimit": 40,
        "fslimit": 2147483648,
        "iolimit": 10000,
        "apiLimit": 2000,
        "dsslimit": 524288000,
        "fulltext": true,
        "interval": 1,
        "transfer": 1099511627776,
        "operations": 800000000,
        "scenarioIO": true,
        "executionTime": 45,
        "restartPeriod": "1 month",
        "customVariables": true,
        "creatingTemplates": true,
        "installPublicApps": true,
        "gracePeriod": 0,
        "productManagement": "salesforce"
      },
      "serviceName": "default",
      "teams": [
        {
          "id": 4,
          "name": "My Team",
          "externalId": null
        }
      ],
      "isPaused": false,
      "zone": "white.label.example.com",
      "externalId": null,
      "scenarios": 0,
      "activeScenarios": 0,
      "deleted": true,
      "tfaEnforced": false
    }
  ],
  "pg": {
    "sortBy": "id",
    "limit": 10000,
    "sortDir": "desc",
    "offset": 0
  }
}

Create an organization

post

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/admin/organizations

Create a new organization in the Make White Label instance. You can set the organization admin, timezone, country and features with the countryId, timezoneId, userOrgAdmin and license parameters in the request body.

If you don't use the countryId and timezoneId parameters Make uses your account values to set the organization timezone and country.

If you don't use the userOrgAdmin parameter you are set as the organization admin.

The license object sets the features and limits for the users in the organization. The following table lists all license parameters and their maximum, minimum, or available values for enumerated parameters. If you don't use the license parameter Make sets the organization's license to the default values for your Make White Label instance. You can check the default license of your Make White Label instance with the get default license endpoint.

Parameter	Description and values
restartPeriod	The period of time after which Make resets an organization's centicredits, operations, and data transfer. Type: enum<string> Values: 1 month 1 year
operations REQUIRED	The number of operations that are available to scenarios in the organization. Operations reset after the restart period. Type: uinteger Values: min: 0 max: 800000000
transfer REQUIRED	The maximum amount of data transfer in bytes available to scenarios in the organization. Transfer resets after the restart period. Type: uinteger Values: min: 104857600 max: 1099511627776
dslimit REQUIRED	The maximum number of data stores in the organization. Type: uinteger Values: min: 1 max: 1000
dsslimit REQUIRED	The maximum storage in bytes available across all data stores in the organization. Type: uinteger Values: min: 1 max: 2306867200
interval REQUIRED	The minimum interval between two scheduled scenario executions in minutes. The interval setting is ignored when the scenario scheduling is set to "immediately". Type: uinteger Values: min: 1 max: 15
teams	The maximum number of teams in the organization. Unlimited if not specified. Type: uinteger Values: min: 1 max: 1000
retention	The number of days to store internal logs (activity stream, userdata fulltext, userdata, debugdata) for the organization. The retention parameter limits for example the scenario execution detail storage duration. Scenario executions older than the retention period have only information about the scenario execution start and status. Type: enum<uinteger> Values: 7 30 60 default: 60
premiumApps	Users in the organization have access to premium apps that have the same or lower premium tier as the value of the premiumApps parameter. To check the installed apps premium tier: 1. List all installed apps with the API call GET /admin/apps to get the app names in the name field. 2. Run the API call GET /admin/apps/{appName}. Check the field premiumTier for the premium tier of the app. Type: uinteger Values: min: 1 max: 10
priority	Sets the scenario execution priority of the scenarios in the organization. Make executes scenarios from an execution queue. If there are scenarios scheduled to run at the same time, Make orders them for execution according to their priority. Type: enum<string> Values: low medium high
allowOverage	Sets the percentage by which scenarios can exceed the number of available centicredits, operations, and data transfer. For example, if the organization has the operations limit 1000 and the allowOverage parameter set to 120, the scenarios in the organization can use up to 1200 operations before Make stops and inactivates them. Type: uinteger Values: min: 100 max: 200
apiLimit	Sets a limit to the number of API calls per minute to work with the data contained in the organization. If a user is part of multiple organizations, Make limits API calls to each organization according to the organization's apiLimit. If you don't specify the apiLimit, Make sets the apiLimit to 0, which disables access to the data in the organization with the API. Type: uinteger Values: min: 0 max: 2000
fulltext	Allows full text search in the scenario execution history to the users in the organization. Type: boolean
dedicatedSso	Allows logging in to the White Label platform with a custom single sign-on solution. Type: boolean
installPublicApps	Allows installation of apps that were created by user that is not part of the organization. Type: boolean
creatingTemplates	Allows the users to create scenario templates. Type: boolean
scenarios	Sets the maximum number of active scenarios in the organization. The number is unlimited if not specified. Type: uinteger Values: min: 1 max: 1000000
dlqStorage	Sets the maximum storage in bytes for the scenario incomplete executions. Type: uinteger Values: min: 1 max: 2097152000
executionTime	The maximum duration of a scenario execution in minutes. Type: uinteger Values: min: 5 max: 45
customVariables	Allows using the custom variables feature. Type: boolean
customFunctions	Allows using the custom functions feature. Type: boolean
fslimit REQUIRED	Maximum individual file size in bytes that a scenario in the organization can transfer. Type: uinteger Values: min: 5242880 max: 1048576000
productManagement	Defines the subscription management method. Organizations in the Make White Label platform must have this parameter set to "salesforce". You cannot change the value of this parameter. Type: enum<string> Values: salesforce
iolimit REQUIRED	Sets the maximum size of input and output webhook queues. Type: uinteger Values: min: 10 max: 10000
gracePeriod	Sets a time limit in days during which the organization has access to all of its features without payment. Organizations in the Make White Label platform must have this parameter set to 0. You cannot change the value of this parameter. Type: uinteger Values: 0
appslimit	Sets the maximum number of apps used by all active scenarios in the organization. Unlimited if not specified. Type: uinteger
onDemandScheduling	Allows scenario On-Demand scheduling. Type: boolean
scenarioIO	Allows the scenario inputs feature for the scenarios in the organization. Type: boolean
customProperties	Enables the custom properties feature. With custom properties, your users can add custom metadata to scenarios and use them to sort and filter their scenarios. The specified number sets the maximum number of structure items in a custom property structure. Type: uinteger Values: default: 100
auditLogsDays	Set the parameter to a non-zero number to enable the audit logs feature. With audit logs, you can track and review user actions in Make. In addition, users with the "Owner," "Admin" and "Team Admin" roles can view audit logs in Make. The specified number is the amount of days for which Make stores the audit log entries. The default value 0 disables the feature. Type: uinteger Values: default: 0
webhookLogRetentionDays	Sets the number of days for which Make keeps webhook logs. Type: uinteger Values: default: 3 min: 3 max: 30
dynamicDependencies	Enables dynamic dependencies in a scenario. Dynamic dependencies allow users to map Make entities, like connections or data stores, in their scenarios. For example, dynamic connections are dynamic dependencies. Type: boolean Values: default: false
dynamicConnections	Enables dynamic connections in a scenario. To allow using dynamic connections, you have to enable dynamic dependencies as well. Type: boolean Values: default: false
scenarioRelationTree	Enables the Relation tree tab in the scenario detail and controls the display of the scenario relation information in the list of scenarios and scenario history. If the parameter is disabled, users cannot see any scenario relation information. Read more about subscenarios. Type: boolean Values: default: false

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

application/json

namestringRequired

The name of the organization.

timezoneIdintegerOptional

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

countryIdintegerOptional

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

userOrgAdminintegerOptional

The ID of the user who will be the admin of the organization. Get the list of the user IDs with the API call GET /admin/users.

Responses

200

Successful response

application/json

post

/admin/organizations

HTTPcURLJavaScriptPython

POST /api/v2/admin/organizations HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "Default organization"
}

Use defaultsSet manually

200

Successful response

{
  "organization": {
    "name": "Default organization",
    "timezoneId": 113,
    "countryId": 42,
    "license": {
      "dslimit": 50,
      "fslimit": 1048576000,
      "iolimit": 10000,
      "dsslimit": 230686720,
      "interval": 1,
      "transfer": 104857600,
      "scenarios": 4,
      "operations": 800000000,
      "gracePeriod": 0,
      "customVariables": false,
      "productManagement": "salesforce"
    },
    "serviceName": "default",
    "teams": [
      {
        "id": null,
        "name": "My team"
      }
    ],
    "isPaused": false,
    "zone": "white.label.zone.com",
    "externalId": null,
    "scenarios": 0,
    "activeScenarios": 0,
    "deleted": false
  },
  "userOrganizationRole": {
    "userId": 4,
    "organizationId": 22,
    "userRoleId": 11,
    "invitation": null,
    "ssoPending": false
  }
}

Delete an organization

delete

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/admin/organizations/{organizationId}

Deletes the specified organization. All data associated with the organization and with the teams in the organization, such as data stores and scenarios, are also deleted.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

organizationnumberOptional

delete

/admin/organizations/{organizationId}

HTTPcURLJavaScriptPython

DELETE /api/v2/admin/organizations/{organizationId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "organization": 10
}

Update organization

patch

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/admin/organizations/{organizationId}

Updates the specified organization. Updates only parameters specified in the request body. Check the API call to create organizations for a full breakdown of the organization license parameters.

When updating organization's license, Make replaces the old organization's license with the new one. You have to send a valid license object with all the license parameters you want to set for the organization.

You can set the next reset of the organization's consumption with the nextReset parameter.

Use the performReset parameter to reset the organization's consumption with the API call. You can set the next reset with the nextReset parameter, or Make sets the next reset according to the organization's resetPeriod.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

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

application/json

namestringOptional

The name of the organization.

timezoneIdintegerOptional

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

countryIdintegerOptional

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

nextResetstring · date-timeOptional

The moment to which you want to schedule the reset of the organization's consumption.

performResetbooleanOptional

Set to true if you want to reset the organization's consumption with the API call. Make sets the next reset of the organization's consumption either to the moment from the nextReset parameter, or according to the organization's restart period.

Responses

200

Successful response

application/json

patch

/admin/organizations/{organizationId}

HTTPcURLJavaScriptPython

PATCH /api/v2/admin/organizations/{organizationId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 346

{
  "name": "Updated organization",
  "timezoneId": 113,
  "countryId": 1,
  "license": {
    "dslimit": 20,
    "fslimit": 6242880,
    "iolimit": 10000,
    "apiLimit": 2000,
    "dsslimit": 524288000,
    "fulltext": true,
    "interval": 1,
    "transfer": 105000000,
    "operations": 100000,
    "executionTime": 45,
    "restartPeriod": "1 month",
    "customVariables": true,
    "creatingTemplates": true,
    "installPublicApps": true
  }
}

Update organizationReset organization's consumption

200

Successful response

{
  "organization": {
    "id": 10,
    "name": "Updated organization",
    "timezoneId": 113,
    "countryId": 1,
    "lastReset": "2023-06-05T12:00:00.000Z",
    "nextReset": "2023-07-05T12:00:00.000Z",
    "license": {
      "dslimit": 20,
      "fslimit": 6242880,
      "iolimit": 10000,
      "apiLimit": 2000,
      "dsslimit": 524288000,
      "fulltext": true,
      "interval": 1,
      "transfer": 105000000,
      "operations": 100000,
      "executionTime": 45,
      "restartPeriod": "1 month",
      "customVariables": true,
      "creatingTemplates": true,
      "installPublicApps": true,
      "gracePeriod": 0,
      "productManagement": "salesforce"
    },
    "serviceName": "default",
    "teams": [
      {
        "id": 155364,
        "name": "My team"
      }
    ],
    "isPaused": false,
    "zone": "white.label.example.com",
    "externalId": null,
    "scenarios": 0,
    "activeScenarios": 0,
    "deleted": false,
    "tfaEnforced": false
  }
}