Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
Resources

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:

Quick reference ​

TypeResourceDescription
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 /api/v2/managed_users/:managed_user_id/developer_api_clients

Path parameters ​

NameTypeDescription
managed_user_idstring
required		The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.

Query parameters ​

NameTypeDescription
pageinteger
optional		Page number of the API clients to fetch. Defaults to 1.
per_pageinteger
optional		Number of API clients to return in a single page. Defaults to 100. Max is 100.

Sample request ​

shell
curl -X GET "https://www.workato.com/api/v2/managed_users/E1234/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 /api/v2/managed_users/:managed_user_id/developer_api_clients

Path parameters ​

NameTypeDescription
managed_user_idstring
required		The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.

Request body ​

NameTypeDescription
namestring
required		Name of the API client
api_privilege_group_idinteger
required		ID of the API client role.
all_foldersboolean
required		Indicates if the client has access to all folders. Must be true, false, 1, or 0.
folder_idsarray
conditional		List of folder IDs. Required if all_folders is false.
environment_namestring
conditional		Name of the environment. Required if your workspace has environments enabled.
ip_allow_liststring
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://www.workato.com/api/v2/managed_users/E1234/developer_api_clients \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Test Client",
            "api_privilege_group_id": 26779,
            "environment_name": "Development",
            "all_folders": true,
            "ip_allow_list": "192.0.2.10,198.51.100.5"
          }'

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 /api/v2/managed_users/:managed_user_id/developer_api_clients/:id

Path parameters ​

NameTypeDescription
managed_user_idstring
required		The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.
idinteger
required		ID of the API Client.

Sample request ​

shell
curl  -X GET https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948 \
      -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 /api/v2/managed_users/:managed_user_id/developer_api_clients/:id

Path parameters ​

NameTypeDescription
managed_user_idstring
required		The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.
idinteger
required		ID of the API Client.

Request body ​

NameTypeDescription
namestring
optional		Updated name of the API client
api_privilege_group_idinteger
optional		Updated API client role ID
all_foldersboolean
optional		Indicates whether the client has access to all folders. Must be true, false, 1, or 0.
folder_idsarray
conditional		Array of folder IDs. Required if all_folders is false.
environment_namestring
conditional		Name of the environment. Required if your workspace has environments enabled.
ip_allow_liststring
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://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948 \
      -H 'Authorization: Bearer <api_token>'  \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Test Client",
            "api_privilege_group_id": 26779,
            "environment_name": "Development",
            "all_folders": true,
            "ip_allow_list": "192.0.2.10,198.51.100.5"
          }'

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 /api/v2/managed_users/:managed_user_id/developer_api_clients/:id

Path parameters ​

NameTypeDescription
managed_user_idstring
required		The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.
idinteger
required		ID of the API Client.

Sample request ​

shell
curl  -X DELETE https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948 \
      -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 /api/v2/managed_users/:managed_user_id/developer_api_clients/:id/regenerate

Path parameters ​

NameTypeDescription
managed_user_idstring
required		The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.
idinteger
required		ID of the API Client.

Sample request ​

shell
curl  -X POST https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948/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.

text
GET /api/v2/managed_users/:managed_user_id/developer_api_client_roles

Path parameters ​

NameTypeDescription
managed_user_idstring
required		The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.

Query parameters ​

NameTypeDescription
pageinteger
optional		Page number. Defaults to 1.
per_pageinteger
optional		Page size. Defaults to 100. The maximum is 100.

Sample request ​

shell
curl  -X GET https://www.workato.com/api/v2/managed_users/E1234/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.

text
POST /api/v2/managed_users/:managed_user_id/developer_api_client_roles/:id/copy

Path parameters ​

NameTypeDescription
managed_user_idstring
required		The Embedded customer ID or external ID.
External IDs must be URL encoded and prefixed with an E, for example: EA2300.
idinteger
required		The ID of the Developer API client role to copy.

Request body ​

NameTypeDescription
namestring
required		The name assigned to the copied Developer API client role.

Sample request ​

shell
curl  -X POST https://www.workato.com/api/v2/managed_users/E1234/developer_api_client_roles/416281/copy \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Read-only API client (copy)"
          }'

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: