Quo API

https://www.quo.com/docs/mdx/api-reference
Admin
Quo API is a REST-based communication platform that enables developers to integrate phone...
Tokens:84,746
Snippets:384
Trust Score:8.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GET /calls

Source: https://www.quo.com/docs/mdx/api-reference/calls/list-calls

Documentation for the GET /calls endpoint, including query parameters, authorization, and response schema.

```APIDOC
## GET /calls

### Description
Retrieves a list of calls associated with a Quo number, with optional filtering by user, participants, and creation date. Supports pagination via maxResults and pageToken.

### Method
GET

### Endpoint
/calls

### Parameters
#### Query Parameters
- **phoneNumberId** (string) - Required - The unique identifier of the Quo number associated with the call. Pattern: `^PN(.*)$`. Example: `"PN123abc"`
- **userId** (string) - Optional - The unique identifier of the user whose access scope is applied to the results. Scopes the response to calls accessible to the specified user. Defaults to the workspace owner. Pattern: `^US(.*)$`. Example: `"US123abc"`
- **participants** (string[]) - Required - The phone numbers of participants involved in the call conversation, excluding your Quo number. Each number should contain the country code and conform to the E.164 format. Currently limited to one-to-one (1:1) conversations only. Pass the "participants" key without brackets, e.g. "participants=%2B15555555555". Maximum array length: `1`. Minimum string length: `1`. Example: `"+15555555555"`
- **since** (string<date-time>) - Optional - DEPRECATED, use "createdAfter" or "createdBefore" instead. "since" incorrectly behaves as "createdBefore" and will be removed in an upcoming release. Example: `"2022-01-01T00:00:00Z"`
- **createdAfter** (string<date-time>) - Optional - Filter results to only include calls created after the specified date and time, in ISO 8601 format. Example: `"2022-01-01T00:00:00Z"`
- **createdBefore** (string<date-time>) - Optional - Filter results to only include calls created before the specified date and time, in ISO 8601 format. Example: `"2022-01-01T00:00:00Z"`
- **maxResults** (integer) - Required - Maximum number of results to return per page. Default: 10. Required range: `1 <= x <= 100`
- **pageToken** (string) - Optional - Token for pagination.

### Authorizations
- **Authorization** (string, header) - Required

### Response
#### Success Response (200)
- **data** (object[]) - Required - Array of items. Show child attributes.
- **totalItems** (integer) - Required - Total number of items available. ⚠️ Note: `totalItems` is not accurately returning the total number of items that can be paginated. We are working on fixing this issue.
- **nextPageToken** (string | null) - Required - Token for the next page.

#### Error Responses
- **404 Not Found** - Returns an error object with code `0100404`, status 404, and title "Not Found".
- **500 Unknown** - Returns an error object with code `0101500`, status 500, and title "Unknown".

#### Error Response Example
{
  "message": "<string>",
  "code": "0100404",
  "status": 404,
  "docs": "https://quo.com/docs",
  "title": "Not Found",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```

--------------------------------

### 402 error response example

Source: https://www.quo.com/docs/mdx/api-reference/messages/send-a-text-message

Example 402 error response for Subscription Expired. Includes error code 0201402 and a description that the subscription has expired.

```json
{
  "message": "<string>",
  "code": "0201402",
  "status": 402,
  "docs": "https://quo.com/docs",
  "title": "Subscription Expired",
  "description": "Your subscription has expired",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

```

--------------------------------

### 404 error response example

Source: https://www.quo.com/docs/mdx/api-reference/messages/send-a-text-message

Example 404 error response for Not Found. Includes error code 0200404.

```json
{
  "message": "<string>",
  "code": "0200404",
  "status": 404,
  "docs": "https://quo.com/docs",
  "title": "Not Found",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

```

--------------------------------

### GET /v1/users

Source: https://www.quo.com/docs/mdx/api-reference/users/list-users

API documentation for listing users via the Quo API.

```APIDOC
## GET /v1/users

### Description
Retrieves a list of users. Supports pagination with `maxResults` and `pageToken` query parameters.

### Method
GET

### Endpoint
https://api.quo.com/v1/users

### Parameters
#### Query Parameters
- **maxResults** (integer) - Optional - Maximum number of results to return per page. Default: 10. Required range: `1 <= x <= 50`.
- **pageToken** (string) - Optional - Token for retrieving the next page of results.

#### Headers
- **Authorization** (string) - Required - API key for authentication.

### Request Example
```
curl --request GET \
  --url 'https://api.quo.com/v1/users?maxResults=10' \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
- **data** (array) - List of user objects.
  - **id** (string) - Unique identifier of the user.
  - **email** (string) - Email address of the user.
  - **firstName** (string) - First name of the user.
  - **lastName** (string) - Last name of the user.
  - **pictureUrl** (string) - URL of the user's picture.
  - **role** (string) - Role of the user (e.g., owner).
  - **createdAt** (string) - Timestamp when the user was created.
  - **updatedAt** (string) - Timestamp when the user was last updated.
- **totalItems** (integer) - Total number of users matching the query.
- **nextPageToken** (string) - Token for the next page of results.

#### Response Example
```
{
  "data": [
    {
      "id": "US123abc",
      "email": "johndoe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "pictureUrl": "https://example.com/picture.jpg",
      "role": "owner",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}
```

#### Error Responses
- **400 Bad Request** - Invalid request parameters.
- **401 Unauthorized** - Missing or invalid authentication.
- **403 Forbidden** - Insufficient permissions.
- **404 Not Found** - Resource not found.
- **500 Unknown** - Internal server error.

Error response body includes: `message`, `code`, `status`, `docs`, `title`, `trace`, and `errors` array with `path`, `message`, `schema`, and `value` fields.
```

--------------------------------

### 403 error response example

Source: https://www.quo.com/docs/mdx/api-reference/messages/send-a-text-message

Example 403 error response for A2P 10DLC Daily Message Cap Reached. Includes error code 0204403 and a description with a support link.

```json
{
  "message": "<string>",
  "code": "0204403",
  "status": 403,
  "docs": "https://quo.com/docs",
  "title": "A2P 10DLC Daily Message Cap Reached",
  "description": "A2P 10DLC Daily limit reached. For help increasing this limit, visit https://support.quo.com/help/submit-a-request",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

```

--------------------------------

### cURL request to get a call summary

Source: https://www.quo.com/docs/mdx/api-reference/calls/get-a-summary-for-a-call

Sends a GET request to the call-summaries endpoint with the callId path parameter and an Authorization header containing the API key.

```bash
curl --request GET \
  --url https://api.quo.com/v1/call-summaries/{callId} \
  --header 'Authorization: <api-key>'
```

--------------------------------

### 401 error response example

Source: https://www.quo.com/docs/mdx/api-reference/messages/send-a-text-message

Example 401 error response for Unauthorized. Includes error code 0200401 and an errors array.

```json
{
  "message": "<string>",
  "code": "0200401",
  "status": 401,
  "docs": "https://quo.com/docs",
  "title": "Unauthorized",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

```

--------------------------------

### 400 error response example

Source: https://www.quo.com/docs/mdx/api-reference/messages/send-a-text-message

Example 400 error response for A2P Registration Not Approved. Includes error code 0206400, status 400, and an errors array with path, message, schema, and value.

```json
{
  "message": "<string>",
  "code": "0206400",
  "status": 400,
  "docs": "https://quo.com/docs",
  "title": "A2P Registration Not Approved",
  "description": "A2P Registration Not Approved",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

```

--------------------------------

### GET /v1/webhooks

Source: https://www.quo.com/docs/mdx/api-reference/webhooks/lists-all-webhooks

Retrieves a list of all webhooks configured for the authenticated user or organization.

```APIDOC
## GET /v1/webhooks

### Description
Lists all webhooks for the authenticated user or organization.

### Method
GET

### Endpoint
https://api.quo.com/v1/webhooks

### Parameters
#### Headers
- **Authorization** (string) - Required - API key for authentication.

### Request Example
```
curl --request GET \
  --url https://api.quo.com/v1/webhooks \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
- **data** (array) - List of webhook objects.
  - **id** (string) - Webhook ID.
  - **userId** (string) - User ID.
  - **orgId** (string) - Organization ID.
  - **label** (string) - Webhook label.
  - **status** (string) - Webhook status (e.g., enabled).
  - **url** (string) - Webhook URL.
  - **key** (string) - Webhook key.
  - **createdAt** (string) - Creation timestamp.
  - **updatedAt** (string) - Last update timestamp.
  - **deletedAt** (string) - Deletion timestamp (if applicable).
  - **events** (array of strings) - List of event types.
  - **resourceIds** (array of strings) - List of resource IDs.

#### Response Example
```
{
  "data": [
    {
      "id": "WHabcd1234",
      "userId": "US123abc",
      "orgId": "OR1223abc",
      "label": "my webhook label",
      "status": "enabled",
      "url": "https://example.com/",
      "key": "example-key",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z",
      "deletedAt": "2022-01-01T00:00:00Z",
      "events": [
        "message.received"
      ],
      "resourceIds": [
        "PN1234"
      ]
    }
  ]
}
```

#### Error Responses
- **400** - Invalid Version
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **500** - Unknown

#### Error Response Example (400)
```
{
  "message": "<string>",
  "code": "0305400",
  "status": 400,
  "docs": "https://quo.com/docs",
  "title": "Invalid Version",
  "description": "Invalid Version",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```
```

--------------------------------

### cURL request to get a user by ID

Source: https://www.quo.com/docs/mdx/api-reference/users/get-a-user-by-id

Sends a GET request to the Quo API to retrieve a user by their ID. Requires an API key in the Authorization header. The userId path parameter must match the pattern ^US(.*)$.

```bash
curl --request GET \
  --url https://api.quo.com/v1/users/{userId} \
  --header 'Authorization: <api-key>'
```

--------------------------------

### 202 response example

Source: https://www.quo.com/docs/mdx/api-reference/messages/send-a-text-message

Example 202 response body for a successful message send. Contains message details such as id, to, from, text, phoneNumberId, conversationId, direction, userId, status, timestamps, and optional media.

```json
{
  "data": {
    "id": "AC123abc",
    "to": [
      "+15555555555"
    ],
    "from": "+15555555555",
    "text": "Hello, world!",
    "phoneNumberId": "PN123abc",
    "conversationId": "CN123abc",
    "direction": "incoming",
    "userId": "US123abc",
    "status": "sent",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "media": [
      {
        "url": "https://example.com/image.png",
        "type": "image/png"
      }
    ]
  }
}

```

--------------------------------

### GET /v1/tasks

Source: https://www.quo.com/docs/mdx/api-reference/tasks/list-tasks

Fetches a list of tasks. Supports pagination via maxResults and nextPageToken.

```APIDOC
## GET /v1/tasks

### Description
Retrieves a paginated list of tasks.

### Method
GET

### Endpoint
https://api.quo.com/v1/tasks

### Parameters
#### Query Parameters
- **maxResults** (integer) - Optional - Maximum number of results to return.
- **nextPageToken** (string) - Optional - Token for fetching the next page of results.

### Request Example
```
curl --request GET \
  --url 'https://api.quo.com/v1/tasks?maxResults=50' \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
- **data** (array) - List of task objects.
- **totalItems** (integer) - Total number of tasks.
- **nextPageToken** (string) - Token for the next page.

#### Response Example
```
{
  "data": [
    {
      "taskId": "<string>",
      "phoneNumberId": "<string>",
      "conversationId": "<string>",
      "activityId": "<string>",
      "phoneNumberGroupId": "<string>",
      "orgId": "<string>",
      "title": "<string>",
      "description": "<string>",
      "dueDate": "2023-11-07T05:31:56Z",
      "assignedTo": "<string>",
      "assignedBy": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "completed": true,
      "isDeleted": true,
      "revision": "<string>"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}
```

### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **402** - Open Tasks Limit Reached
- **403** - Forbidden
- **404** - Not Found
- **500** - Unknown

#### Error Response Example
```
{
  "message": "<string>",
  "code": "0600400",
  "status": 400,
  "docs": "https://quo.com/docs",
  "title": "Bad Request",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```
```

--------------------------------

### 200 OK response for list users

Source: https://www.quo.com/docs/mdx/api-reference/users/list-users

Successful response containing an array of user objects, totalItems count, and a nextPageToken for pagination.

```json
{
  "data": [
    {
      "id": "US123abc",
      "email": "johndoe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "pictureUrl": "https://example.com/picture.jpg",
      "role": "owner",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}
```

--------------------------------

### GET /v1/contacts

Source: https://www.quo.com/docs/mdx/api-reference/contacts/list-contacts

This snippet documents the GET /v1/contacts endpoint, including its query parameters, request example, success response schema, and error responses.

```APIDOC
## GET /v1/contacts

### Description
Retrieves a list of contacts from the Quo API. This endpoint supports pagination via the `maxResults` query parameter and returns contact details including default and custom fields.

### Method
GET

### Endpoint
https://api.quo.com/v1/contacts

### Parameters
#### Query Parameters
- **maxResults** (integer) - Optional - The maximum number of contacts to return in the response. Example: `10`.

### Request Example
```
curl --request GET \
  --url 'https://api.quo.com/v1/contacts?maxResults=10' \
  --header 'Authorization: <api-key>'
```

### Response
#### Success Response (200)
- **data** (array) - List of contact objects.
  - **id** (string) - Unique identifier for the contact.
  - **externalId** (string) - External identifier for the contact.
  - **source** (string) - Source of the contact (e.g., "public-api").
  - **sourceUrl** (string) - URL to the contact in the source system.
  - **defaultFields** (object) - Default contact fields.
    - **company** (string) - Company name.
    - **emails** (array) - List of email objects.
      - **name** (string) - Email label.
      - **value** (string) - Email address.
      - **id** (string) - Email identifier.
    - **firstName** (string) - First name.
    - **lastName** (string) - Last name.
    - **phoneNumbers** (array) - List of phone number objects.
      - **name** (string) - Phone label.
      - **value** (string) - Phone number.
      - **id** (string) - Phone identifier.
    - **role** (string) - Role of the contact.
  - **customFields** (array) - List of custom field objects.
    - **name** (string) - Custom field name.
    - **type** (string) - Custom field type (e.g., "multi-select").
    - **value** (array) - Custom field value(s).
    - **key** (string) - Custom field key.
    - **id** (string) - Custom field identifier.
  - **createdAt** (string) - Creation timestamp (ISO 8601).
  - **updatedAt** (string) - Last update timestamp (ISO 8601).
  - **createdByUserId** (string) - ID of the user who created the contact.
- **totalItems** (integer) - Total number of contacts matching the query.
- **nextPageToken** (string) - Token for the next page of results.

#### Response Example
```
{
  "data": [
    {
      "id": "664d0db69fcac7cf2e6ec",
      "externalId": "664d0db69fcac7cf2e6ec",
      "source": "public-api",
      "sourceUrl": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec",
      "defaultFields": {
        "company": "Quo",
        "emails": [
          {
            "name": "company email",
            "value": "abc@example.com",
            "id": "acb123"
          }
        ],
        "firstName": "John",
        "lastName": "Doe",
        "phoneNumbers": [
          {
            "name": "company phone",
            "value": "+12345678901",
            "id": "acb123"
          }
        ],
        "role": "Sales"
      },
      "customFields": [
        {
          "name": "Inbound Lead",
          "type": "multi-select",
          "value": [
            "option1",
            "option2"
          ],
          "key": "inbound-lead",
          "id": "66d0d87d534de8fd1c433cec3"
        }
      ],
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z",
      "createdByUserId": "US123abc"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}
```

### Error Responses
#### 400 Bad Request
- **message** (string) - Error message.
- **code** (string) - Error code (e.g., "0801400").
- **status** (integer) - HTTP status code.
- **docs** (string) - Documentation URL.
- **title** (string) - Error title.
- **description** (string) - Error description.
- **trace** (string) - Trace identifier.
- **errors** (array) - List of error details.
  - **path** (string) - Field path.
  - **message** (string) - Error message.
  - **schema** (object) - Schema information.
    - **type** (string) - Schema type.
  - **value** (unknown) - Invalid value.

#### 401 Unauthorized
- **message** (string) - Error message.
- **code** (string) - Error code (e.g., "0800401").
- **status** (integer) - HTTP status code.
- **docs** (string) - Documentation URL.
- **title** (string) - Error title.
- **trace** (string) - Trace identifier.
- **errors** (array) - List of error details.
  - **path** (string) - Field path.
  - **message** (string) - Error message.
  - **schema** (object) - Schema information.
    - **type** (string) - Schema type.
  - **value** (unknown) - Invalid value.

#### 403 Forbidden
- **message** (string) - Error message.
- **code** (string) - Error code (e.g., "0801403").
- **status** (integer) - HTTP status code.
- **docs** (string) - Documentation URL.
- **title** (string) - Error title.
- **description** (string) - Error description.
- **trace** (string) - Trace identifier.
- **errors** (array) - List of error details.
  - **path** (string) - Field path.
  - **message** (string) - Error message.
  - **schema** (object) - Schema information.
    - **type** (string) - Schema type.
  - **value** (unknown) - Invalid value.

#### 404 Not Found
- **message** (string) - Error message.
- **code** (string) - Error code (e.g., "0800404").
- **status** (integer) - HTTP status code.
- **docs** (string) - Documentation URL.
- **title** (string) - Error title.
- **trace** (string) - Trace identifier.
- **errors** (array) - List of error details.
  - **path** (string) - Field path.
  - **message** (string) - Error message.
  - **schema** (object) - Schema information.
    - **type** (string) - Schema type.
  - **value** (unknown) - Invalid value.

#### 409 Conflict
- **message** (string) - Error message.
- **code** (string) - Error code (e.g., "0800409").
- **status** (integer) - HTTP status code.
- **docs** (string) - Documentation URL.
- **title** (string) - Error title.
- **trace** (string) - Trace identifier.
- **errors** (array) - List of error details.
  - **path** (string) - Field path.
  - **message** (string) - Error message.
  - **schema** (object) - Schema information.
    - **type** (string) - Schema type.
  - **value** (unknown) - Invalid value.

#### 500 Internal Server Error
- **message** (string) - Error message.
- **code** (string) - Error code (e.g., "0801500").
- **status** (integer) - HTTP status code.
- **docs** (string) - Documentation URL.
- **title** (string) - Error title.
- **trace** (string) - Trace identifier.
- **errors** (array) - List of error details.
  - **path** (string) - Field path.
  - **message** (string) - Error message.
  - **schema** (object) - Schema information.
    - **type** (string) - Schema type.
  - **value** (unknown) - Invalid value.
```

--------------------------------

### 200 response for Get a message by ID

Source: https://www.quo.com/docs/mdx/api-reference/messages/get-a-message-by-id

Example 200 response body for a successful GET request. Contains message details such as id, to, from, text, phoneNumberId, conversationId, direction, userId, status, timestamps, and optional media array.

```json
{
  "data": {
    "id": "AC123abc",
    "to": [
      "+15555555555"
    ],
    "from": "+15555555555",
    "text": "Hello, world!",
    "phoneNumberId": "PN123abc",
    "conversationId": "CN123abc",
    "direction": "incoming",
    "userId": "US123abc",
    "status": "sent",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "media": [
      {
        "url": "https://example.com/image.png",
        "type": "image/png"
      }
    ]
  }
}
```

--------------------------------

### List all webhooks with cURL

Source: https://www.quo.com/docs/mdx/api-reference/webhooks/lists-all-webhooks

Lists all webhooks for the authenticated user. Requires an API key passed in the Authorization header.

```bash
curl --request GET \
  --url https://api.quo.com/v1/webhooks \
  --header 'Authorization: <api-key>'
```

--------------------------------

### 500 error response for Get a message by ID

Source: https://www.quo.com/docs/mdx/api-reference/messages/get-a-message-by-id

Example 500 error response. Indicates an unknown error with code 0201500.

```json
{
  "message": "<string>",
  "code": "0201500",
  "status": 500,
  "docs": "https://quo.com/docs",
  "title": "Unknown",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```

--------------------------------

### 404 error response for Get a message by ID

Source: https://www.quo.com/docs/mdx/api-reference/messages/get-a-message-by-id

Example 404 error response. Indicates resource not found with code 0200404.

```json
{
  "message": "<string>",
  "code": "0200404",
  "status": 404,
  "docs": "https://quo.com/docs",
  "title": "Not Found",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```

--------------------------------

### 402 error response for Get a message by ID

Source: https://www.quo.com/docs/mdx/api-reference/messages/get-a-message-by-id

Example 402 error response. Indicates subscription expired with code 0201402.

```json
{
  "message": "<string>",
  "code": "0201402",
  "status": 402,
  "docs": "https://quo.com/docs",
  "title": "Subscription Expired",
  "description": "Your subscription has expired",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```

--------------------------------

### Create a new webhook for call summaries with cURL

Source: https://www.quo.com/docs/mdx/api-reference/webhooks/create-a-new-webhook-for-call-summaries

Creates a new webhook for call summaries. The request body includes the event type, destination URL, label, resource IDs, status, and user ID. Requires an API key in the Authorization header.

```bash
curl --request POST \
  --url https://api.quo.com/v1/webhooks/call-summaries \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "call.summary.completed"
  ],
  "url": "https://example.com",
  "label": "my webhook label",
  "resourceIds": [
    "PN1234"
  ],
  "status": "enabled",
  "userId": "US123abc"
}
'

```

--------------------------------

### 401 error response for Get a message by ID

Source: https://www.quo.com/docs/mdx/api-reference/messages/get-a-message-by-id

Example 401 error response. Indicates unauthorized access with code 0200401.

```json
{
  "message": "<string>",
  "code": "0200401",
  "status": 401,
  "docs": "https://quo.com/docs",
  "title": "Unauthorized",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```

--------------------------------

### 400 error response for Get a message by ID

Source: https://www.quo.com/docs/mdx/api-reference/messages/get-a-message-by-id

Example 400 error response. Indicates A2P registration not approved with code 0206400.

```json
{
  "message": "<string>",
  "code": "0206400",
  "status": 400,
  "docs": "https://quo.com/docs",
  "title": "A2P Registration Not Approved",
  "description": "A2P Registration Not Approved",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```

--------------------------------

### List tasks with cURL

Source: https://www.quo.com/docs/mdx/api-reference/tasks/list-tasks

Lists tasks from the Quo API. Requires an API key in the Authorization header. The maxResults query parameter is set to 50.

```bash
curl --request GET \
  --url 'https://api.quo.com/v1/tasks?maxResults=50' \
  --header 'Authorization: <api-key>'
```

--------------------------------

### 403 error response for Get a message by ID

Source: https://www.quo.com/docs/mdx/api-reference/messages/get-a-message-by-id

Example 403 error response. Indicates A2P 10DLC daily message cap reached with code 0204403.

```json
{
  "message": "<string>",
  "code": "0204403",
  "status": 403,
  "docs": "https://quo.com/docs",
  "title": "A2P 10DLC Daily Message Cap Reached",
  "description": "A2P 10DLC Daily limit reached. For help increasing this limit, visit https://support.quo.com/help/submit-a-request",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```

--------------------------------

### 200 OK response for listing webhooks

Source: https://www.quo.com/docs/mdx/api-reference/webhooks/lists-all-webhooks

Example 200 response body returned when the request succeeds. Contains an array of webhook objects with fields such as id, userId, orgId, label, status, url, key, timestamps, events, and resourceIds.

```json
{
  "data": [
    {
      "id": "WHabcd1234",
      "userId": "US123abc",
      "orgId": "OR1223abc",
      "label": "my webhook label",
      "status": "enabled",
      "url": "https://example.com/",
      "key": "example-key",
      "createdAt": "2022-01-01T00:00:00Z",
      "updatedAt": "2022-01-01T00:00:00Z",
      "deletedAt": "2022-01-01T00:00:00Z",
      "events": [
        "message.received"
      ],
      "resourceIds": [
        "PN1234"
      ]
    }
  ]
}
```

--------------------------------

### 201 Success response for creating a webhook

Source: https://www.quo.com/docs/mdx/api-reference/webhooks/create-a-new-webhook-for-messages

Example of a successful 201 response containing the created webhook object with id, userId, orgId, label, status, url, key, timestamps, events, and resourceIds.

```json
{
  "data": {
    "id": "WHabcd1234",
    "userId": "US123abc",
    "orgId": "OR1223abc",
    "label": "my webhook label",
    "status": "enabled",
    "url": "https://example.com/",
    "key": "example-key",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "deletedAt": "2022-01-01T00:00:00Z",
    "events": [
      "message.received"
    ],
    "resourceIds": [
      "PN1234"
    ]
  }
}
```

--------------------------------

### 200 OK response for get voicemail

Source: https://www.quo.com/docs/mdx/api-reference/calls/get-a-voicemail-for-a-call

Example 200 OK response containing the voicemail data object with duration, id, transcript, recordingUrl, and status fields.

```json
{
  "data": {
    "duration": 60,
    "id": "VMaaff8f317e0c4e61953b74a5eb42a370",
    "transcript": "Hello, this is a voicemail from John Doe.",
    "recordingUrl": "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3",
    "status": "completed"
  }
}
```

--------------------------------

### 200 OK response for get contact by ID

Source: https://www.quo.com/docs/mdx/api-reference/contacts/get-a-contact-by-id

Example of a successful 200 response containing the contact's data, including default fields, custom fields, and timestamps.

```json
{
  "data": {
    "id": "664d0db69fcac7cf2e6ec",
    "externalId": "664d0db69fcac7cf2e6ec",
    "source": "public-api",
    "sourceUrl": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec",
    "defaultFields": {
      "company": "Quo",
      "emails": [
        {
          "name": "company email",
          "value": "abc@example.com",
          "id": "acb123"
        }
      ],
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumbers": [
        {
          "name": "company phone",
          "value": "+12345678901",
          "id": "acb123"
        }
      ],
      "role": "Sales"
    },
    "customFields": [
      {
        "name": "Inbound Lead",
        "type": "multi-select",
        "value": [
          "option1",
          "option2"
        ],
        "key": "inbound-lead",
        "id": "66d0d87d534de8fd1c433cec3"
      }
    ],
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "createdByUserId": "US123abc"
  }
}
```

--------------------------------

### cURL request to create a task

Source: https://www.quo.com/docs/mdx/api-reference/tasks/create-a-task

Sends a POST request to https://api.quo.com/v1/tasks with an Authorization header and JSON body containing title, description, phoneNumberId, dueDate, and assignedTo.

```bash
curl --request POST \
  --url https://api.quo.com/v1/tasks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Follow up with customer",
  "description": "Discuss pricing and onboarding next steps.",
  "phoneNumberId": "<string>",
  "dueDate": "2023-11-07T05:31:56Z",
  "assignedTo": "<string>"
}
'
```

--------------------------------

### POST /v1/webhooks/call-summaries

Source: https://www.quo.com/docs/mdx/api-reference/webhooks/create-a-new-webhook-for-call-summaries

Creates a new webhook for call summaries. This endpoint requires an API key for authentication and accepts a JSON payload with event types, URL, label, resource IDs, status, and user ID. The response includes the created webhook details with a 201 status code.

```APIDOC
## [POST] /v1/webhooks/call-summaries

### Description
Creates a new webhook for call summaries. This endpoint requires an API key for authentication and accepts a JSON payload with event types, URL, label, resource IDs, status, and user ID. The response includes the created webhook details with a 201 status code.

### Method
POST

### Endpoint
/v1/webhooks/call-summaries

### Parameters
#### Request Body
- **events** (array of string) - Required - List of event types to subscribe to. Example: ["call.summary.completed"]
- **url** (string) - Required - The URL where the webhook payload will be sent.
- **label** (string) - Optional - A label for the webhook.
- **resourceIds** (array of string) - Optional - List of resource IDs to associate with the webhook.
- **status** (string) - Optional - Status of the webhook. Example: "enabled"
- **userId** (string) - Optional - The ID of the user associated with the webhook.

### Request Example
{
  "events": [
    "call.summary.completed"
  ],
  "url": "https://example.com",
  "label": "my webhook label",
  "resourceIds": [
    "PN1234"
  ],
  "status": "enabled",
  "userId": "US123abc"
}

### Response
#### Success Response (201)
- **data** (object) - The created webhook object.
  - **id** (string) - Unique identifier for the webhook.
  - **userId** (string) - ID of the user associated with the webhook.
  - **orgId** (string) - ID of the organization.
  - **label** (string) - Label of the webhook.
  - **status** (string) - Status of the webhook.
  - **url** (string) - The webhook URL.
  - **key** (string) - The webhook key.
  - **createdAt** (string) - Creation timestamp.
  - **updatedAt** (string) - Last update timestamp.
  - **deletedAt** (string) - Deletion timestamp, if applicable.
  - **events** (array of string) - List of subscribed events.
  - **resourceIds** (array of string) - List of associated resource IDs.

#### Response Example
{
  "data": {
    "id": "WHabcd1234",
    "userId": "US123abc",
    "orgId": "OR1223abc",
    "label": "my webhook label",
    "status": "enabled",
    "url": "https://example.com/",
    "key": "example-key",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "deletedAt": "2022-01-01T00:00:00Z",
    "events": [
      "call.summary.completed"
    ],
    "resourceIds": [
      "PN1234"
    ]
  }
}

#### Error Responses
- **400 Bad Request** - Invalid request. Response body includes error details.
- **401 Unauthorized** - Authentication failed.
- **403 Forbidden** - Access denied.
- **404 Not Found** - Resource not found.
- **500 Internal Server Error** - Unexpected server error.

#### Error Response Example (400)
{
  "message": "<string>",
  "code": "0305400",
  "status": 400,
  "docs": "https://quo.com/docs",
  "title": "Invalid Version",
  "description": "Invalid Version",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}
```

--------------------------------

### 200 OK response for get call transcription

Source: https://www.quo.com/docs/mdx/api-reference/calls/get-a-transcription-for-a-call

Successful response with the transcript data. The dialogue array contains segments with content, start and end times, identifier, and userId. The status field indicates the call status.

```json
{
  "data": {
    "callId": "ACea724hac8c30465bcbcff0b76e4c1c7b",
    "createdAt": "2022-01-01T00:00:00Z",
    "dialogue": [
      {
        "content": "Hello, world!",
        "start": 5.123456,
        "end": 10.123456,
        "identifier": "+19876543210",
        "userId": "US123abc"
      }
    ],
    "duration": 100,
    "status": "completed"
  }
}
```

--------------------------------

### cURL request to list users

Source: https://www.quo.com/docs/mdx/api-reference/users/list-users

Sends a GET request to the Quo API to list users. Requires an Authorization header with an API key. The maxResults query parameter defaults to 10 and must be between 1 and 50.

```bash
curl --request GET \
  --url 'https://api.quo.com/v1/users?maxResults=10' \
  --header 'Authorization: <api-key>'
```

--------------------------------

### 200 OK response for get phone number by ID

Source: https://www.quo.com/docs/mdx/api-reference/phone-numbers/get-a-phone-number-by-id

Example of a successful response (HTTP 200) containing the phone number details, including id, groupId, portRequestId, formattedNumber, forward, name, number, portingStatus, symbol, users, createdAt, updatedAt, and restrictions.

```json
{
  "data": {
    "id": "PN123bc",
    "groupId": "1234",
    "portRequestId": "123abc",
    "formattedNumber": "+15555555555",
    "forward": "+15555555555",
    "name": "My phone number",
    "number": "+15555555555",
    "portingStatus": "completed",
    "symbol": "🏡",
    "users": [
      {
        "id": "US123abc",
        "email": "johndoe@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "role": "owner",
        "groupId": "GRcei8k90o"
      }
    ],
    "createdAt": " '2022-01-01T00:00:00Z'",
    "updatedAt": " '2022-01-01T00:00:00Z'",
    "restrictions": {
      "calling": {
        "CA": "unrestricted",
        "Intl": "unrestricted",
        "US": "unrestricted"
      },
      "messaging": {
        "CA": "unrestricted",
        "Intl": "unrestricted",
        "US": "unrestricted"
      }
    }
  }
}
```
Tokens:
Raw