Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /talkdesk | Type: Application | PCID required: Yes

​
Tools

ToolDescription
talkdesk_get_usersGet list of users in the Talkdesk account. Uses the Users API (users:read scope).
talkdesk_get_userGet detailed information about a specific user by ID.
talkdesk_get_contactRetrieve a contact by ID (returns single contact) or search by phone number (returns paginated list).
talkdesk_requestMake a raw API request to any Talkdesk endpoint. Use when you need to call APIs not covered by the specialized tools (e.g. ring-groups, data/reports/calls/jobs, recordings). Provide the path (with optional query string) and HTTP method. Access is gated by the connection’s OAuth scopes - 401 means the token lacks the required scope for that path. Common paths: users, users/{id}, users/me, contacts, contacts/{id}, ring-groups, data/reports/calls/jobs, calls/{id}/recordings, recordings/{id}.

​
talkdesk_get_users

Get list of users in the Talkdesk account. Uses the Users API (users:read scope). Parameters:
ParameterTypeRequiredDefaultDescription
pagenumberNo—Page number (default 1)
perPagenumberNo20Results per page (1-200)
activebooleanNo—Filter by activation status
emailstringNo—Filter by email address

​
talkdesk_get_user

Get detailed information about a specific user by ID. Parameters:
ParameterTypeRequiredDefaultDescription
userIdstringYes—User ID to retrieve

​
talkdesk_get_contact

Retrieve a contact by ID (returns single contact) or search by phone number (returns paginated list). Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringNo—Contact ID (returns single contact)
phoneNumberstringNo—Phone number in E.164 format (returns paginated list)

​
talkdesk_request

Make a raw API request to any Talkdesk endpoint. Use when you need to call APIs not covered by the specialized tools (e.g. ring-groups, data/reports/calls/jobs, recordings). Provide the path (with optional query string) and HTTP method. Access is gated by the connection’s OAuth scopes - 401 means the token lacks the required scope for that path. Common paths: users, users/{id}, users/me, contacts, contacts/{id}, ring-groups, data/reports/calls/jobs, calls/{id}/recordings, recordings/{id}. Parameters:
ParameterTypeRequiredDefaultDescription
pathstringYes—API path (e.g. users, users/123, ring-groups, data/reports/calls/jobs). Include query params in path if needed (e.g. users?page=2&per_page=10).
methodstringNo"GET"HTTP method
bodyobjectNo—Request body for POST/PUT (JSON object)