Private Spaces

The following endpoints allow you to manage private spaces in your organization.

List private spaces

get

/private-spaces

Gets the list of private spaces in the organization with 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.

Query parameters

organizationIdintegerRequired

The ID of the organization.

Example: 1

externalIdstringOptional

Filter private spaces by external ID.

Example: 42

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/private-spaces

GET /api/v2/private-spaces?organizationId=1 HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "default-cols": {
    "summary": "List private spaces with default columns",
    "privateSpaces": [
      {
        "id": 10,
        "name": "John's space",
        "organizationId": 1,
        "globalAgentsEnabled": false,
        "type": "personal",
        "privateSpaceOwnerName": "John Doe",
        "privateSpaceOwnerEmail": "john.doe@example.com",
        "privateSpaceOwnerId": 42
      }
    ],
    "pg": {
      "sortBy": "name",
      "sortDir": "asc",
      "limit": 10000,
      "offset": 0
    }
  },
  "all-cols": {
    "summary": "List private spaces with all columns",
    "privateSpaces": [
      {
        "id": 10,
        "name": "John's space",
        "organizationId": 1,
        "globalAgentsEnabled": false,
        "type": "personal",
        "privateSpaceOwnerName": "John Doe",
        "privateSpaceOwnerEmail": "john.doe@example.com",
        "privateSpaceOwnerId": 42,
        "operationsLimit": 10000,
        "transferLimit": "536870912",
        "consumedOperations": 42,
        "consumedTransfer": "1024",
        "isPaused": false,
        "consumedCenticredits": 500
      }
    ],
    "pg": {
      "sortBy": "name",
      "sortDir": "asc",
      "limit": 10000,
      "offset": 0
    }
  }
}

Get a private space

get

/private-spaces/{privateSpaceId}

Returns the details of a single private space. Requires the personal team own view organization permission. Non-members receive a 404.

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

privateSpaceIdintegerRequired

The ID of the private space.

Example: 10

Query parameters

Responses

200

Successful response

application/json

get/private-spaces/{privateSpaceId}

GET /api/v2/private-spaces/{privateSpaceId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "privateSpace": {
    "id": 10,
    "name": "John's space",
    "organizationId": 1,
    "globalAgentsEnabled": false,
    "type": "personal",
    "privateSpaceOwnerName": "John Doe",
    "privateSpaceOwnerEmail": "john.doe@example.com",
    "privateSpaceOwnerId": 42
  }
}

Update a private space

patch

/private-spaces/{privateSpaceId}

Updates a private space. Currently supports changing the operations limit (credit limit). Requires the personal team manage organization 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

privateSpaceIdintegerRequired

The ID of the private space.

Example: 10

Query parameters

confirmedbooleanOptional

When true, confirms the operation even if the new limit is below the current consumption. This will pause the private space.

Body

operationsLimitinteger · nullableOptional

Optional. The new operations limit for the private space. Transfer limit is auto-calculated. Set to null to remove limits, omit to leave unchanged.

Example: 10000

Responses

200

Successful response

application/json

patch/private-spaces/{privateSpaceId}

PATCH /api/v2/private-spaces/{privateSpaceId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "operationsLimit": 10000
}

200

Successful response

{
  "privateSpace": {
    "id": 10,
    "name": "John's space",
    "organizationId": 1,
    "deleted": false,
    "externalId": null,
    "globalAgentsEnabled": false,
    "type": "personal",
    "privateSpaceOwnerName": "John Doe",
    "privateSpaceOwnerEmail": "john.doe@example.com",
    "privateSpaceOwnerId": 42,
    "operationsLimit": 10000,
    "transferLimit": "536870912",
    "consumedOperations": 42,
    "consumedTransfer": "1024",
    "isPaused": false,
    "consumedCenticredits": 500
  }
}

PreviousMMS NextRemote Procedures

Last updated 34 minutes ago