API clients

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

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.

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

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

curl -X GET "https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients" \
     -H 'Authorization: Bearer <api_token>'

Response

{
    "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,
                "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

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.

Payload

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.

Sample request

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
          }'

Response

{
    "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,
        "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

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

curl  -X GET https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948 \
      -H 'Authorization: Bearer <api_token>' 

Response

{
    "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

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.

Payload

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.

Sample request

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
          }'

Response

{
    "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,
        "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

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

curl  -X DELETE https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948 \
      -H 'Authorization: Bearer <api_token>' 

Response

{
    "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

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

curl  -X POST https://www.workato.com/api/v2/managed_users/E1234/developer_api_clients/40948/regenerate \
      -H 'Authorization: Bearer <api_token>' 

Response

{
    "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..."
        }
    }
}