Make your first request

You need a Protodesk workspace and permission to create an API key. These examples use curl and make read-only requests.

Create an API key

Open Settings → API in the Protodesk dashboard. Create a key with the Customers → Read permission (customers:read). Copy the secret when it is shown and store it in your server’s secret manager. Set PROTODESK_API_KEY in your terminal environment before running the examples. Keep API keys out of frontend code, repositories, and screenshots.

Verify your workspace

curl --fail-with-body https://api.protodesk.io/v1/me \
  -H "Authorization: Bearer $PROTODESK_API_KEY"

The response identifies the key’s workspace and permissions. For example:

{
  "apiKeyId": "key_example",
  "workspaceId": "workspace_example",
  "scopes": ["customers:read"]
}

Check that workspaceId is the workspace you intend to access. The key selects the workspace; you do not send a separate workspace header.

List customers

curl --fail-with-body 'https://api.protodesk.io/v1/customers?limit=5' \
  -H "Authorization: Bearer $PROTODESK_API_KEY"

An empty workspace returns an empty data array. When more results exist, follow nextCursor as described in Pagination.

Keys with a pk_test_ prefix do not select a separate sandbox database. Requests still access the key’s workspace. Use a dedicated test workspace for integration development.

Next steps

Review authentication and permissions.
Build a customer and conversation workflow.
Browse the API reference for complete request schemas.

Get started

API essentials

Build an integration

Make your first request

Create an API key

Verify your workspace

List customers

Next steps

​Create an API key

​Verify your workspace

​List customers

​Next steps

Create an API key

Verify your workspace

List customers

Next steps