API clients

The following endpoints allow you to manage API clients and client roles within a customer workspace. Use these endpoints to programmatically create new API clients for your customers or rotate API tokens regularly.

Rate limits

API client resources have the following rate limits:

Type	Resource	Quota
GET	List Developer API Clients: /api/v2/managed_users/:managed_user_id /developer_api_clients	1,000 requests per minute
GET	List Developer API Client roles: /api/v2/managed_users/:managed_user_id /developer_api_client_roles	1,000 requests per minute
All	All other API Client endpoints	60 requests per minute

Quick reference

Type	Resource	Description
GET	/api/v2/managed_users/:managed_user_id/developer_api_clients	List Developer API clients in a customer workspace.
POST	/api/v2/managed_users/:managed_user_id/developer_api_clients	Create a Developer API client in a customer workspace.
GET	/api/v2/managed_users/:managed_user_id/developer_api_clients/:id	Get a Developer API client by ID in a customer workspace.
PUT	/api/v2/managed_users/:managed_user_id/developer_api_clients/:id	Update a Developer API client in a customer workspace.
DELETE	/api/v2/managed_users/:managed_user_id/developer_api_clients/:id	Delete a Developer API client in a customer workspace.
POST	/api/v2/managed_users/:managed_user_id/developer_api_clients/:id/regenerate	Regenerate a Developer API client token in a customer workspace.
GET	/api/v2/managed_users/:managed_user_id/developer_api_client_roles	List Developer API client roles in a customer workspace.
POST	/api/v2/managed_users/:managed_user_id/developer_api_client_roles/:id/copy	Copy a Developer API client role in a customer workspace.

List Developer API clients

List all Developer API clients in a customer workspace.

GET https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients

Path parameters

Name	Type	Description
managed_user_id	string required	The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an `E`, for example: `EA2300`.

Query parameters

Name	Type	Description
page	integer optional	Page number of the API clients to fetch. Defaults to `1`.
per_page	integer optional	Number of API clients to return in a single page. Defaults to `100`. Max is `100`.

Sample request

shell

curl -X GET "https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients" \
     -H 'Authorization: Bearer <api_token>'

Response

json

{
    "result": {
        "count": 1,
        "items": [
            {
                "id": 40947,
                "name": "Test",
                "api_privilege_group_id": 26779,
                "created_at": "2023-02-22T01:55:35.739-08:00",
                "updated_at": "2023-02-28T01:23:18.046-08:00",
                "all_folders": false,
                "folder_ids": [
                    26138,
                    26136
                ],
                "environment_name": "Development",
                "environment_id": 3218,
                "ip_allow_list": "192.0.2.10,198.51.100.5",
                "token": {
                    "updated_at": "2023-02-22T09:55:36.427Z"
                }
            }
        ]
    }
}

Create a Developer API client

Create a Developer API client in a customer workspace.

POST https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients

Path parameters

Name	Type	Description
managed_user_id	string required	The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an `E`, for example: `EA2300`.

Request body

Name	Type	Description
name	string required	Name of the API client
api_privilege_group_id	integer required	ID of the API client role.
all_folders	boolean required	Indicates if the client has access to all folders. Must be `true`, `false`, `1`, or `0`.
folder_ids	array conditional	List of folder IDs. Required if `all_folders` is `false`.
environment_name	string conditional	Name of the environment. Required if your workspace has environments enabled.
ip_allow_list	string optional	Array of IP addresses allowed to access the API client. Defaults to all IPs if not specified.

Sample request

shell

curl  -X POST https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": ":name",
            "api_privilege_group_id": :api_privilege_group_id_value,
            "environment_name": ":environment_name",
            "all_folders": :all_folders_value,
            "ip_allow_list": ":ip_allow_list"
          }'

Response

json

{
    "result": {
        "id": 40948,
        "name": "Test Client",
        "api_privilege_group_id": 26779,
        "created_at": "2023-02-28T02:09:07.255-08:00",
        "updated_at": "2023-02-28T02:09:07.586-08:00",
        "all_folders": true,
        "environment_name": "Development",
        "environment_id": 3218,
        "ip_allow_list": "192.0.2.10,198.51.100.5",
        "token": {
            "updated_at": "2023-02-28T10:09:07.579Z",
            "value": "wrkaus-eyJhbGciOiJSUz..."
        }
    }
}

Get a Developer API client by ID

Retrieve a Developer API client in a customer workspace by its ID.

GET https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients/:id

Path parameters

Name	Type	Description
managed_user_id	string required	The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an `E`, for example: `EA2300`.
id	integer required	ID of the API Client.

Sample request

shell

curl  -X GET https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients/:id \
      -H 'Authorization: Bearer <api_token>'

Response

json

{
    "result": {
        "id": 40948,
        "name": "Test Client",
        "api_privilege_group_id": 26779,
        "created_at": "2023-02-28T02:09:07.255-08:00",
        "updated_at": "2023-02-28T02:09:07.586-08:00",
        "all_folders": false,
        "folder_ids": [26138, 26136],
        "environment_name": "Development",
        "environment_id": 3218,
        "token": {
            "updated_at": "2023-02-28T10:09:07.579Z"
        }
    }
}

Update a Developer API client

Update a Developer API client in a customer workspace.

PUT https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients/:id

Path parameters

Name	Type	Description
managed_user_id	string required	The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an `E`, for example: `EA2300`.
id	integer required	ID of the API Client.

Request body

Name	Type	Description
name	string optional	Updated name of the API client
api_privilege_group_id	integer optional	Updated API client role ID
all_folders	boolean optional	Indicates whether the client has access to all folders. Must be `true`, `false`, `1`, or `0`.
folder_ids	array conditional	Array of folder IDs. Required if `all_folders` is false.
environment_name	string conditional	Name of the environment. Required if your workspace has environments enabled.
ip_allow_list	string optional	Array of IP addresses allowed to access the API client. Defaults to all IPs if not specified.

Sample request

shell

curl  -X PUT https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients/:id \
      -H 'Authorization: Bearer <api_token>'  \
      -H 'Content-Type: application/json' \
      -d '{
            "name": ":name",
            "api_privilege_group_id": :api_privilege_group_id_value,
            "environment_name": ":environment_name",
            "all_folders": :all_folders_value,
            "ip_allow_list": ":ip_allow_list"
          }'

Response

json

{
    "result": {
        "id": 40948,
        "name": "Test Client",
        "api_privilege_group_id": 26779,
        "created_at": "2023-02-28T02:09:07.255-08:00",
        "updated_at": "2023-02-28T02:09:07.586-08:00",
        "all_folders": true,
        "environment_name": "Development",
        "environment_id": 3218,
        "ip_allow_list": "192.0.2.10,198.51.100.5",
        "token": {
            "updated_at": "2023-02-28T10:09:07.579Z"
        },
        "user": {
            "id": 3218,
            "name": "Workato Customer Success test"
        }
    }
}

Delete a Developer API client

Delete a Developer API client in a customer workspace.

DELETE https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients/:id

Path parameters

Name	Type	Description
managed_user_id	string required	The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an `E`, for example: `EA2300`.
id	integer required	ID of the API Client.

Sample request

shell

curl  -X DELETE https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients/:id \
      -H 'Authorization: Bearer <api_token>'

Response

json

{
    "result": "success"
}

Regenerate a Developer API client token

Regenerates the API token for an API client in a customer workspace. This invalidates the previous API token.

POST https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients/:id/regenerate

Path parameters

Name	Type	Description
managed_user_id	string required	The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an `E`, for example: `EA2300`.
id	integer required	ID of the API Client.

Sample request

shell

curl  -X POST https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_clients/:id/regenerate \
      -H 'Authorization: Bearer <api_token>'

Response

json

{
    "result": {
        "id": 40948,
        "name": "Test new API client",
        "api_privilege_group_id": 26779,
        "created_at": "2023-01-29T22:30:12.930-08:00",
        "updated_at": "2023-02-28T02:19:16.542-08:00",
        "all_folders": true,
        "environment_name": "Development",
        "environment_id": 3218,
        "token": {
            "updated_at": "2023-02-28T10:19:16.530Z",
            "value": "wrkaus-eyJhbGc..."
        }
    }
}

List Developer API client roles

Returns a list of Developer API client roles in a customer workspace.

GET https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_client_roles

Path parameters

Name	Type	Description
managed_user_id	string required	The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an `E`, for example: `EA2300`.

Query parameters

Name	Type	Description
page	integer optional	Page number. Defaults to 1.
per_page	integer optional	Page size. Defaults to 100. The maximum is 100.

Sample request

shell

curl  -X GET https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_client_roles \
      -H 'Authorization: Bearer <api_token>'

Response

json

{
    "data": [
        {
            "id": 416281,
            "name": "Read-only API client",
            "created_at": "2025-09-10T09:17:48.292-07:00",
            "updated_at": "2025-09-10T09:17:48.292-07:00"
        },
        {
            "id": 416282,
            "name": "Full-access API client",
            "created_at": "2025-09-10T09:17:54.676-07:00",
            "updated_at": "2025-09-10T09:18:02.740-07:00"
        }
    ],
    "count": 2,
    "page": 1,
    "per_page": 100
}

Copy a Developer API client role

Creates a copy of an Embedded customer's Developer API client role.

POST https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_client_roles/:id/copy

Path parameters

Name	Type	Description
managed_user_id	string required	The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an `E`, for example: `EA2300`.
id	integer required	The ID of the Developer API client role to copy.

Request body

Name	Type	Description
name	string required	The name assigned to the copied Developer API client role.

Sample request

shell

curl  -X POST https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/developer_api_client_roles/:id/copy \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": ":name"
          }'

Response

json

{
    "data": {
        "id": 416283,
        "name": "Read-only API client (copy)",
        "created_at": "2025-09-10T09:21:14.459-07:00",
        "updated_at": "2025-09-10T09:21:14.459-07:00"
    }
}

Last updated:

API clients ​

Rate limits ​

Quick reference ​

List Developer API clients ​

Path parameters ​

Query parameters ​

Sample request ​

Response ​

Create a Developer API client ​

Path parameters ​

Request body ​

Sample request ​

Response ​

Get a Developer API client by ID ​

Path parameters ​

Sample request ​

Response ​

Update a Developer API client ​

Path parameters ​

Request body ​

Sample request ​

Response ​

Delete a Developer API client ​

Path parameters ​

Sample request ​

Response ​

Regenerate a Developer API client token ​

Path parameters ​

Sample request ​

Response ​

List Developer API client roles ​

Path parameters ​

Query parameters ​

Sample request ​

Response ​

Copy a Developer API client role ​

Path parameters ​

Request body ​

Sample request ​

Response ​

API clients

Rate limits

Quick reference

List Developer API clients

Path parameters

Query parameters

Sample request

Response

Create a Developer API client

Path parameters

Request body

Sample request

Response

Get a Developer API client by ID

Path parameters

Sample request

Response

Update a Developer API client

Path parameters

Request body

Sample request

Response

Delete a Developer API client

Path parameters

Sample request

Response

Regenerate a Developer API client token

Path parameters

Sample request

Response

List Developer API client roles

Path parameters

Query parameters

Sample request

Response

Copy a Developer API client role

Path parameters

Request body

Sample request

Response