> ## 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.

# talkdesk

> Contact center agents, calls, queues, and recordings

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

## Tools

| Tool                                            | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`talkdesk_get_users`](#talkdesk_get_users)     | Get list of users in the Talkdesk account. Uses the Users API (users:read scope).                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| [`talkdesk_get_user`](#talkdesk_get_user)       | Get detailed information about a specific user by ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| [`talkdesk_get_contact`](#talkdesk_get_contact) | Retrieve a contact by ID (returns single contact) or search by phone number (returns paginated list).                                                                                                                                                                                                                                                                                                                                                                                                             |
| [`talkdesk_request`](#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}. |

***

## talkdesk\_get\_users

Get list of users in the Talkdesk account. Uses the Users API (users:read scope).

**Parameters:**

| Parameter | Type    | Required | Default | Description                 |
| --------- | ------- | -------- | ------- | --------------------------- |
| `page`    | number  | No       | —       | Page number (default 1)     |
| `perPage` | number  | No       | `20`    | Results per page (1-200)    |
| `active`  | boolean | No       | —       | Filter by activation status |
| `email`   | string  | No       | —       | Filter by email address     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "page": {
        "type": "number",
        "description": "Page number (default 1)"
      },
      "perPage": {
        "type": "number",
        "default": 20,
        "description": "Results per page (1-200)"
      },
      "active": {
        "type": "boolean",
        "description": "Filter by activation status"
      },
      "email": {
        "type": "string",
        "description": "Filter by email address"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## talkdesk\_get\_user

Get detailed information about a specific user by ID.

**Parameters:**

| Parameter | Type   | Required | Default | Description         |
| --------- | ------ | -------- | ------- | ------------------- |
| `userId`  | string | Yes      | —       | User ID to retrieve |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "userId": {
        "type": "string",
        "description": "User ID to retrieve"
      }
    },
    "required": [
      "PCID",
      "userId"
    ]
  }
  ```
</Expandable>

***

## talkdesk\_get\_contact

Retrieve a contact by ID (returns single contact) or search by phone number (returns paginated list).

**Parameters:**

| Parameter     | Type   | Required | Default | Description                                           |
| ------------- | ------ | -------- | ------- | ----------------------------------------------------- |
| `contactId`   | string | No       | —       | Contact ID (returns single contact)                   |
| `phoneNumber` | string | No       | —       | Phone number in E.164 format (returns paginated list) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "contactId": {
        "type": "string",
        "description": "Contact ID (returns single contact)"
      },
      "phoneNumber": {
        "type": "string",
        "description": "Phone number in E.164 format (returns paginated list)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## 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:**

| Parameter | Type   | Required | Default | Description                                                                                                                                       |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `path`    | string | Yes      | —       | 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). |
| `method`  | string | No       | `"GET"` | HTTP method                                                                                                                                       |
| `body`    | object | No       | —       | Request body for POST/PUT (JSON object)                                                                                                           |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID"
      },
      "path": {
        "type": "string",
        "description": "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)."
      },
      "method": {
        "type": "string",
        "enum": [
          "GET",
          "POST",
          "PUT",
          "DELETE"
        ],
        "default": "GET",
        "description": "HTTP method"
      },
      "body": {
        "type": "object",
        "additionalProperties": true,
        "description": "Request body for POST/PUT (JSON object)"
      }
    },
    "required": [
      "PCID",
      "path"
    ]
  }
  ```
</Expandable>