Get support

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"}
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","countryId","timezoneId","license","zone","serviceName","teams","isPaused","externalId","productName"]}
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
GET /api/v2/organizations HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "organizations": [
    {
      "id": 5,
      "name": "New organization",
      "timezoneId": 113
    },
    {
      "id": 6,
      "name": "New organization",
      "timezoneId": 113
    }
  ],
  "pg": {
    "sortBy": "name",
    "sortDir": "asc",
    "limit": 10000,
    "offset": 0
  }
}

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.

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
POST /api/v2/organizations HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "name": "New organization I",
  "regionId": 1,
  "timezoneId": 113,
  "countryId": 1
}
200

Successful response

{
  "organization": {
    "id": 9,
    "name": "New organization",
    "timezoneId": 113,
    "countryId": 1,
    "license": {
      "apps": [],
      "users": 50,
      "dslimit": 40,
      "fslimit": 2147483648,
      "iolimit": 10000,
      "advsched": true,
      "dsslimit": 524288000,
      "fulltext": true,
      "interval": 1,
      "transfer": 1099511627776,
      "operations": 800000000
    },
    "zone": "slave1.make.cloud",
    "serviceName": "default",
    "teams": [
      {
        "id": 6,
        "name": "My Team"
      }
    ],
    "isPaused": false
  },
  "userOrganizationRole": {
    "userId": 3,
    "organizationId": 9,
    "usersRoleId": 11,
    "invitation": null
  }
}

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
GET /api/v2/organizations/invitation?hash=text HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "organization": {
    "id": 13,
    "name": "New organization"
  },
  "user": {
    "id": 1,
    "name": "Martin",
    "email": "[email protected]",
    "language": "en",
    "timezoneId": 113,
    "localeId": 18,
    "countryId": 1,
    "features": {},
    "avatar": "https://secure.gravatar.com/avatar/6b1a74d20d925c12a73af32bf0dd7164.jpg?d=mm"
  },
  "userOrganizationRole": {
    "userId": 1,
    "organizationId": 13,
    "usersRoleId": 12,
    "invitation": "pending"
  }
}

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
POST /api/v2/organizations/accept-invitation HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "hash": "bf1effe1-bc9d-4ab3-9414-9c3b66175305"
}
200

Successful response

{
  "user": {
    "id": 1,
    "name": "Martin",
    "email": "[email protected]",
    "language": "en",
    "timezoneId": 113,
    "localeId": 18,
    "countryId": 1,
    "features": {},
    "avatar": "https://secure.gravatar.com/avatar/6b1a74d20d925c12a73af32bf0dd7164.jpg?d=mm"
  },
  "userOrganizationRole": {
    "userId": 1,
    "organizationId": 13,
    "usersRoleId": 12,
    "invitation": null
  }
}

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}
GET /api/v2/organizations/{organizationId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "organization": {
    "id": 10,
    "name": "Organization 10",
    "serviceName": "unlimited",
    "nextReset": null,
    "operations": "0",
    "transfer": "0",
    "centicreditsConsumed": "0",
    "operationsExt": "0",
    "transferExt": "0",
    "centicreditsExtra": "0",
    "unusedOperations": "0",
    "unusedTransfer": "0",
    "unusedCenticredits": "0",
    "isPaused": false,
    "countryId": 1,
    "timezoneId": 113,
    "deleted": false,
    "license": {
      "apps": [
        "T2",
        "T3"
      ],
      "users": 50,
      "dslimit": 40,
      "fslimit": 2147483648,
      "iolimit": 10000,
      "dsslimit": 524288000,
      "fulltext": true,
      "interval": 1,
      "transfer": 1099511627776,
      "operations": 800000000
    },
    "features": {},
    "zone": "local.make.cloud",
    "teams": [
      {
        "id": 16,
        "name": "My Team"
      }
    ]
  }
}

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
delete
/organizations/{organizationId}
DELETE /api/v2/organizations/{organizationId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "organization": 11
}

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.

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}
PATCH /api/v2/organizations/{organizationId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "name": "Organization 10",
  "countryId": 1,
  "timezoneId": 113
}
200

Successful response

{
  "organization": {
    "name": "Organization 10",
    "countryId": 1,
    "timezoneId": 113,
    "license": {
      "apps": "T2",
      "users": 50,
      "dslimit": 40,
      "fslimit": 2147483648,
      "iolimit": 10000,
      "dsslimit": 524288000,
      "fulltext": true,
      "interval": 1,
      "transfer": 1099511627776,
      "operations": 800000000
    },
    "zone": "local.make.cloud",
    "serviceName": "limit1",
    "teams": [
      {
        "id": 10,
        "name": "My Team"
      }
    ],
    "isPaused": false,
    "id": 10
  }
}

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
GET /api/v2/organizations/{organizationId}/apps HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "installedApps": [
    {
      "appName": "custom-app-7xpqrg",
      "appVersion": 1,
      "organizationId": 11,
      "installedAt": "2021-02-09T16:36:11.322Z",
      "installedBy": 1
    }
  ]
}

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
GET /api/v2/organizations/{organizationId}/payments HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "payments": [
    {
      "id": "in_1JqwmsAtYi1J9zZU7sIuH39K",
      "invoice_number": "6B52691A-0002",
      "created": "2021-10-25T13:42:55.110Z",
      "type_name": "Invoice",
      "status_name": "Pending",
      "product_name": {
        "cs": "FREE",
        "en": "FREE"
      },
      "payment_method": {
        "type": "card",
        "card": {
          "brand": "visa",
          "last4": "4242",
          "country": "US",
          "network": "visa",
          "exp_year": 2024,
          "exp_month": 4,
          "fingerprint": "pxynXFWHTejV4FMT"
        }
      },
      "amount_total": "666.00",
      "currency_code": "usd",
      "invoice_url": "https://stripe-upload-api.s3.us-west-1.amazonaws.com/uploads/file_1JqywUAtYi1J9zZUQpexvZno?response-content-disposition=attachment%3B%20filename%3D%22Invoice-6B52691A-0002.pdf%22%3B%20filename%2A%3DUTF-8%27%27Invoice-6B52691A-0002.pdf&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIAQOF7EIWLKRZD6LU3%2F20211101%2Fus-west-1%2Fs3%2Faws4_request&X-Amz-Date=20211101T114448Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEGwaCXVzLXdlc3QtMiJIMEYCIQCxou2KGsKnJG42r1NP3MiRrpQ00SPlcn1xZB6HHx3ppQIhAK%2FEX6XQcjDW0r8e4yKdtf3JaztyTyk6ekIUkYPiaHjcKvoDCBUQABoMMDMwNDY1NjA3MDYyIgwIY6ogrqimSlDlMhEq1wMukQCMF4exUATqXHwmmHC%2BmvZAIEbVes0%2FpMFjrg%2BEGul2ljp6GlR4o%2FBvIooJQ0fc2Z4gMLoHMeoLgO5l5Riy7Rg%2FltszuhaJqH%2Bynv%2Fjn1iuBs3LA3z2P2dyVjoEdLjGGWFoDFU%2BfPBCRPrZdlXPHoZTd%2BTNsE6cul%2F%2Fy6klQs0769cFzh03TyfCI1YzxhpSMNqSHZluWA9Cn45Z6u6Km4YpPEi4JSmuYVpzYT6rykyp1dD5S7YMQCg%2BGAGfnuz3fUy6WPh%2FO3CG5KbvEEI1CoDZ6t9jW4IwiBmRRjrso8E%2BMGo8Nc%2FsgddhRiq6QqzsgdEWsrqcMW5%2BVOTtOB%2F2xHXLm1Cq4REwezaViJcDWQFYB9Uw%2FJxa04JU0MD4iy5mjNu%2Bq5LetnLJOCrElb1GefXdHfDeJoBHPug2Ou9rCUU56xsK7T9r%2FL%2F1l0eUfp4NEoTTi6aRE%2FBURtoKTapY0yTizZiVudtYPYGA3Vi3PQlRWCrlvXFPyEk9fRzhpLMVWJbx24TTCN9BhuGAXSck1MFhSBnCpigp%2FPoZlzPQ2eKdKw6iaVbvSD1yf%2BXskhjVvEvdLtOy7Ov4mZH%2Btqq%2B335SkArhB8pkAIRWpLJHi1Kyx2aTj2kwiqP%2FiwY6pAF0q2OG7omGpklvNTB0UoyR2BijWKOGVjshqyC%2Fy6%2FeI3yuDy1Rrpi7nCGyx1f%2BISbgShoW19X2QxZg7oja6XvPj%2FppvKvNV%2BCAFG6fIolKDecD5SRs9jAO5%2FHqVa0TRfdS2m5R0jYKs5SCAn3UlPqbI02%2FKOuGqqIfcgiFCYXDTyRC8xgoqhcQYbKxxnaO7pkYXX3GcHvv%2FoMBtJJTU39EdlDlOw%3D%3D&X-Amz-Signature=8f16f7afe521ac90fa324304f18e4c7179d632fd7a04a1f051ff4710073c2cd9",
      "hosted_invoice_url": "https://invoice.stripe.com/i/acct_1J0LwfAtYi1J9zZU/test_YWNjdF8xSjBMd2ZBdFlpMUo5elpVLF9LV2tkeG5FMm9tRFRvT29GN1ZlSXlhTFFSY1h4aEVG01000rqJfGhG",
      "period_from": "2021-11-01T14:40:07.000Z",
      "period_to": "2021-11-01T14:40:07.000Z"
    }
  ]
}

Create a single payment

post
/organizations/{organizationId}/single-payment-create
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
quantitynumberRequired
couponCodestringOptional
doNotChargebooleanOptional
Responses
200

Successful response

application/json
post
/organizations/{organizationId}/single-payment-create
POST /api/v2/organizations/{organizationId}/single-payment-create HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "priceId": 200,
  "quantity": 1,
  "couponCode": "extraopscoupon",
  "doNotCharge": false,
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "isBusiness": false,
    "countryId": 1,
    "city": "Prague",
    "line1": "Street 1",
    "line2": "Citypart 2"
  }
}
200

Successful response

{
  "ok": 1
}

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
get
/organizations/{organizationId}/subscription
GET /api/v2/organizations/{organizationId}/subscription HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "product": {
    "id": 1,
    "name": "FREE",
    "nextBill": "2021-11-26T13:31:00.082Z",
    "price": {
      "id": 1,
      "price": "0.00",
      "currencyCode": "USD",
      "period": "1 month"
    },
    "coupon": {
      "validFrom": "2021-12-12T10:47:05.334Z",
      "validTo": "2021-12-19T10:47:17.768Z",
      "price": "3.00",
      "currencyCode": "usd",
      "productId": 4,
      "productName": "Teams"
    }
  }
}

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
doNotChargebooleanOptional
Responses
200

Successful response

application/json
post
/organizations/{organizationId}/subscription
POST /api/v2/organizations/{organizationId}/subscription HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "priceId": 3,
  "couponCode": null,
  "doNotCharge": false,
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "isBusiness": false,
    "countryId": 1,
    "city": "Prague",
    "line1": "Some street 1",
    "line2": "Citypart 2"
  }
}
200

Successful response

{
  "sessionId": 123,
  "url": "http://foo.bar",
  "subscriptionId": 519
}

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
delete
/organizations/{organizationId}/subscription
DELETE /api/v2/organizations/{organizationId}/subscription HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "ok": 1
}

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
patch
/organizations/{organizationId}/subscription
PATCH /api/v2/organizations/{organizationId}/subscription HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "priceId": 3,
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "isBusiness": false,
    "countryId": 1,
    "city": "Prague",
    "line1": "Some street 1",
    "line2": "Citypart 2"
  }
}
200

Successful response

{
  "ok": 1
}

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
post
/organizations/{organizationId}/subscription-free
POST /api/v2/organizations/{organizationId}/subscription-free HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "customerId": 213,
  "subscriptionId": 371
}

Apply a coupon

post
/organizations/{organizationId}/subscription/coupon-apply
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
couponCodestringRequired
Body
Responses
200

Successful response

application/json
post
/organizations/{organizationId}/subscription/coupon-apply
POST /api/v2/organizations/{organizationId}/subscription/coupon-apply?couponCode=text HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "customer": {
    "email": "[email protected]",
    "name": "John Doe",
    "isBusiness": false,
    "countryId": 1,
    "city": "Prague",
    "line1": "Some street 1",
    "line2": "Citypart 2"
  }
}
200

Successful response

{
  "ok": 1
}

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
usersRoleIdintegerOptional

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.

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
POST /api/v2/organizations/{organizationId}/invite HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "usersRoleId": 12,
  "email": "[email protected]",
  "name": "Tom",
  "note": "Hi Tom, please join our organization.",
  "teamsId": [
    5,
    26
  ]
}
200

Successful response

{
  "user": {
    "id": 31,
    "name": "Tom",
    "email": "[email protected]",
    "language": "en",
    "timezoneId": 113,
    "localeId": 18,
    "countryId": 1,
    "features": {},
    "avatar": "https://secure.gravatar.com/avatar/ada7391afa4ad83584d00afe3986aef2.jpg?d=mm"
  },
  "userOrganizationRole": {
    "userId": 31,
    "organizationId": 1,
    "usersRoleId": 12,
    "invitation": "pending",
    "organizationTeamsCount": 2,
    "joinedTeamsCount": 1
  }
}

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
GET /api/v2/organizations/{organizationId}/variables HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "organizationVariables": {
    "name": "userId",
    "typeId": 1,
    "value": 123,
    "isSystem": false
  }
}

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
POST /api/v2/organizations/{organizationId}/variables HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "typeId": 1,
  "value": 123,
  "name": "userId"
}
200

Successful response

{
  "organizationVariable": {
    "name": "userId",
    "typeId": 1,
    "value": 123,
    "isSystem": false
  }
}

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
delete
/organizations/{organizationId}/variables/{variableName}
DELETE /api/v2/organizations/{organizationId}/variables/{variableName} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "ok": 1
}

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}
PATCH /api/v2/organizations/{organizationId}/variables/{variableName} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "value": 251
}
200

Successful response

{
  "organizationVariable": {
    "name": "userId",
    "typeId": 1,
    "value": 251
  }
}

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
GET /api/v2/organizations/{organizationId}/variables/{variableName}/history HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "organizationVariableHistory": [
    {
      "id": 1,
      "diffObject": {
        "name": "userId",
        "value": 25,
        "typeId": 1
      },
      "changed": "2022-08-02T09:37:05.364Z",
      "action": "organization_variable_created",
      "author": "Jon Doe"
    },
    {
      "id": 2,
      "diffObject": {
        "old": {
          "value": 25,
          "typeId": 1
        },
        "new": {
          "value": 140,
          "typeId": 1
        }
      },
      "changed": "2022-08-02T09:37:05.364Z",
      "action": "organization_variable_edited",
      "author": "Jon Doe"
    }
  ]
}

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
GET /api/v2/organizations/{organizationId}/usage HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successfully retrieved usage data

{
  "data": [
    {
      "date": "2024-05-30",
      "operations": 9,
      "dataTransfer": 135,
      "centicredits": 900
    },
    {
      "date": "2024-05-31",
      "operations": 15,
      "datatransfer": 157,
      "centicredits": 1500
    }
  ]
}

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
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.

Responses
200

Successfully retrieved feature controls

application/json
get
/organizations/{organizationId}/feature-controls
GET /api/v2/organizations/{organizationId}/feature-controls HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successfully retrieved feature controls

{
  "enableAllControlFeatures": false,
  "featureControls": [
    {
      "id": 2,
      "name": "Make AI Tools",
      "label": {
        "en": "Make AI Tools"
      },
      "description": {
        "en": "Access to Make AI Tools"
      },
      "tags": [
        "Beta"
      ],
      "warning_message": {
        "en": "This feature is in beta."
      },
      "enabled": true
    },
    {
      "id": 1,
      "name": "Advanced Security",
      "label": {
        "en": "Advanced AI Security"
      },
      "description": {
        "en": "Enhanced security features for your organization"
      },
      "tags": [
        "AI"
      ],
      "warning_message": {
        "en": "This feature uses AI."
      },
      "enabled": false
    }
  ]
}

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
PATCH /api/v2/organizations/{organizationId}/feature-controls HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "id": 1,
  "enabled": true
}
200

Successful response

{
  "featureControl": {
    "id": 1,
    "enabled": true
  }
}
PreviousNotificationsNextOrganizations > User organization roles

Last updated