### Generate Helpdesk Domain Setup Flow

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves the domain setup flow for helpdesk. This will return the DNS records required for helpdesk domain setup.

```APIDOC
## Generate Helpdesk Domain Setup Flow

### Description
Retrieves the domain setup flow for helpdesk. This will return the DNS records required for helpdesk domain setup.

### Method
GET

### Endpoint
/v1/website/{website_id}/helpdesk/domain/setup

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

#### Query Parameters
- **custom** (string) - Optional - Custom domain to use for setup
```

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

### List Animation Medias Request Example

Source: https://docs.crisp.chat/references/rest-api/v1

Example of an HTTP GET request to list animation medias. Replace 'page_number' with the desired page number.

```http
GET https://api.crisp.chat/v1/media/animation/list/page_number
```

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

### Send Start Action to Browsing Session

Source: https://docs.crisp.chat/references/rest-api/v1

Use this endpoint to send an action to an existing browsing session, such as starting the stream session. The client acknowledgement is sent back asynchronously.

```HTTP
PATCH /v1/website/{website_id}/conversation/{session_id}/browsing/{browsing_id}
```

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

### List Animation Medias Response Example

Source: https://docs.crisp.chat/references/rest-api/v1

Example of a successful JSON response when listing animation medias. The 'data' object will contain the animation media details.

```json
{
  "error": false,
  "reason": "requested",
  "data": {}
}
```

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

### Get Website Information (GET)

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves information about an existing website using its unique identifier. This endpoint is available for 'user' and 'websiteplugin' tiers.

```http
GET https://api.crisp.chat/v1/website/website_id
```

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

### Get A Website

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves information about an existing website using its unique identifier.

```APIDOC
## GET /v1/website/{website_id}

### Description
Resolves an existing website information.

### Method
GET

### Endpoint
/v1/website/{website_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

### Response
#### Success Response (200)
- **data.website_id** (string) - Website identifier
- **data.name** (string) - Website name
- **data.domain** (string) - Website domain
- **data.logo** (string) - Website custom logo image URL (can be blank)
```

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

### Generate Helpdesk Domain Setup Flow

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves the necessary DNS records for setting up a custom helpdesk domain. This is a prerequisite for domain changes to take effect.

```HTTP
GET /v1/website/{website_id}/helpdesk/domain/setup
```

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

### Get A Campaign Template

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves detailed information for a specific campaign template of a website.

```APIDOC
## Get A Campaign Template

### Description
Resolves campaign template information.

### Method
GET

### Endpoint
/v1/website/{website_id}/campaigns/template/{template_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **template_id** (string) - Required - The template identifier

### Response
#### Success Response (200 OK)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **template_id** (string) - Template identifier
  - **type** (enum[string]) - Template type (`static`, `custom`)
  - **name** (string) - Template name
  - **format** (enum[string]) - Template format (`markdown`, `html`)
  - **content** (string) - Template content
  - **created_at** (number) - Template creation timestamp
  - **updated_at** (number) - Template update timestamp
#### Error Responses
- 403 Forbidden
- 404 Not Found
```

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

### Get Verify Settings

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves the verification settings for a given website. This includes whether user verification is enabled.

```APIDOC
## GET /v1/website/{website_id}/verify/settings

### Description
Resolves verify settings. This endpoint retrieves the current verification status and related settings for a website.

### Method
GET

### Endpoint
/v1/website/{website_id}/verify/settings

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for the error, if any.
- **data** (object) - Contains the verification settings.
  - **enabled** (boolean) - Whether user verification is enabled or not.
```

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

### Get Website Settings

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves the settings for a given website. This includes configurations for the chatbox's default view, overlay behavior, helpdesk integration, appearance themes, and various blocking rules.

```APIDOC
## GET /v1/website/{website_id}/settings

### Description
Retrieves the settings for a given website. This includes configurations for the chatbox's default view, overlay behavior, helpdesk integration, appearance themes, and various blocking rules.

### Method
GET

### Endpoint
/v1/website/{website_id}/settings

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The unique identifier of the website.

#### Query Parameters
None

#### Request Body
None

### Request Example
```
(loading)
```

### Response
#### Success Response (200)
- **home** (boolean) - Whether to show the chatbox home section.
- **overlay_search** (boolean) - Whether to show a button to search in all support resources via Crisp Overlay.
- **overlay_mode** (boolean) - Whether to restrict the chatbox to show search via Crisp Overlay before the user can contact support.
- **helpdesk_link** (boolean) - Whether to show a link to helpdesk in chatbox (if helpdesk is configured).
- **helpdesk_only** (boolean) - Whether to restrict the chatbox to show the helpdesk view only, and disable chat (if helpdesk is configured).
- **helpdesk_navigate** (enum[string]) - Helpdesk navigation mode in the chatbox. Values: `deep`, `frequent`.
- **status_health_dead** (boolean) - Whether to show status banner, when status page reports as dead (if Status Page plugin is used).
- **check_domain** (boolean) - Whether to check website domain before creating sessions or not.
- **color_theme** (enum[string]) - Which color theme to use. Values: `default`, `amber`, `black`, `blue`, `blue_grey`, `light_blue`, `brown`, `cyan`, `green`, `light_green`, `grey`, `indigo`, `orange`, `deep_orange`, `pink`, `purple`, `deep_purple`, `red`, `teal`.
- **color_mode** (enum[string]) - Which color mode to use. Values: `light`, `dark`, `auto`.
- **layout_theme** (enum[string]) - Which layout theme to use. Values: `default`, `colorized`.
- **text_theme** (enum[string]) - Which text theme to use. Values: `default`, `1`, `2`, `3`, `4`.
- **welcome_message** (enum[string]) - Which welcome message to display on chatbox open. Values: `default`, `1`, `2`, `3`, `4`, `5`.
- **locale** (string) - Which locale to enforce (can be blank for auto-detect, ISO 639-1).
- **allowed_pages** (array[string]) - Allowed pages (chatbox is visible only for those page URLs).
- **blocked_pages** (array[string]) - Blocked pages (chatbox is hidden for those page URLs).
- **blocked_countries** (array[string]) - Blocked countries (chatbox is hidden for those countries).
- **blocked_locales** (array[string]) - Blocked locales (chatbox is hidden for those locales, ISO 639-1).
- **blocked_ips** (array[string]) - Blocked IP addresses (chatbox is hidden for those IPs: IPv4 or IPv6, CIDR).

#### Response Example
```
(loading)
```

#### Error Responses
- **403 Forbidden**: Returned if the user does not have permission to access the website settings.
- **404 Not Found**: Returned if the website with the specified ID does not exist.
```

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

### Get Subscription Settings

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves the configuration settings for a plugin subscription on a specific website. This is used to read the current plugin configuration.

```APIDOC
## GET /v1/plugins/subscription/{website_id}/{plugin_id}/settings

### Description
Resolves plugin subscription settings. Used to read plugin configuration on a given website.

### Method
GET

### Endpoint
/v1/plugins/subscription/{website_id}/{plugin_id}/settings

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **plugin_id** (string) - Required - The plugin identifier

### Response
#### Success Response (200)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **plugin_id** (string) - Plugin identifier
  - **website_id** (string) - Website identifier
  - **token** (string) - Subscription secret token (used to authenticate against external configuration forms)
  - **schema** (object) - Configuration schema (JSONSchema)
  - **settings** (object) - Active configuration for subscription (format enforced by configuration schema)
  - **settings_form_url** (string) - URL to external configuration form page (if any)
  - **callback_url** (string) - URL to plugin authentication callback (if any)
```

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

### Get Subscription Details

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves details about a specific plugin subscription for a given website. This includes information about the plugin, its category, price, and associated plans.

```APIDOC
## GET /v1/plugins/subscription/{website_id}/{plugin_id}

### Description
Resolves details on a given subscription.

### Method
GET

### Endpoint
/v1/plugins/subscription/{website_id}/{plugin_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **plugin_id** (string) - Required - The plugin identifier

### Response
#### Success Response (200)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **id** (string) - Plugin identifier
  - **urn** (string) - Plugin Uniform Resource Name
  - **type** (enum[string]) - Plugin type (Values: `internal`, `external`)
  - **name** (string) - Plugin name
  - **category** (enum[string]) - Plugin category (Values: `feature`, `automation`, `cms`, `crm`, `marketing`, `messaging`, `teamwork`, `other`)
  - **summary** (string) - Plugin summary
  - **price** (number) - Plugin price (in platform-wide currency)
  - **plans** (array[object]) - Plans the plugin is included in (if part of a plan)
    - **id** (string) - Plan identifier
    - **name** (string) - Plan name
    - **price** (number) - Plan price (in platform-wide currency)
    - **icon** (string) - Plugin icon URL (if any)
    - **website_url** (string) - Website for the plugin (if any)
    - **contact_url** (string) - Contact address for the plugin (if any)
    - **terms_url** (string) - Terms of use for the plugin (if any)
    - **privacy_url** (string) - Privacy policy for the plugin (if any)
    - **help_url** (string) - Help article for the plugin (if any)
    - **video_url** (string) - Explanatory video for the plugin (if any)
    - **configurable** (boolean) - Whether the plugin can be configured or not
    - **since** (string) - Datetime since when the plugin is available
    - **active** (boolean) - Whether the plugin is active, or has been disabled (eg: due to failed renewal payment)
    - **bill_period** (enum[string]) - Bill period (how often the subscription is paid for) (Values: `monthly`, `yearly`)
    - **bill_valid_until** (string) - Date until which the bill is valid for subscription (date at which the subscription will be renewed, thus paid again)
```

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

### Send Action To An Existing Browsing Session

Source: https://docs.crisp.chat/references/rest-api/v1

Sends an action to an existing browsing session. Used to send stream actions to a browsing session (e.g., to start or stop the stream session).

```APIDOC
## PATCH /v1/website/{website_id}/conversation/{session_id}/browsing/{browsing_id}

### Description
Sends an action to an existing browsing session. Used to send stream actions to a browsing session (eg. to start or stop the stream session).

### Method
PATCH

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/browsing/{browsing_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier
- **browsing_id** (string) - Required - The browsing session identifier

#### Request Body
- **action** (enum[string]) - Required - Browsing action. Values: `start`, `stop`, `heartbeat`

### Response
#### Success Response (202 Accepted)
(No specific fields documented)

#### Error Responses
- 402 Payment Required
- 403 Forbidden
- 404 Not Found
```

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

### Initialize Helpdesk

Source: https://docs.crisp.chat/references/rest-api/v1

Initializes a new helpdesk for a given website. This is the first step to setting up a helpdesk for a new site.

```APIDOC
## POST /v1/website/{website_id}/helpdesk

### Description
Initializes a new helpdesk for website.

### Method
POST

### Endpoint
/v1/website/{website_id}/helpdesk

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

#### Request Body
- **name** (string) - Required - Name of the helpdesk
- **domain_basic** (string) - Required - Basic domain of the helpdesk (subdomain of default root domain)
```

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

### Get Messages Request Example

Source: https://docs.crisp.chat/references/rest-api/v1

This snippet shows the HTTP GET request to retrieve messages from a conversation. Replace `website_id` and `session_id` with your actual values.

```http
GET https://api.crisp.chat/v1/website/website_id/conversation/session_id/messages
```

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

### Create Website (POST)

Source: https://docs.crisp.chat/references/rest-api/v1

Creates a new website with a specified name and domain. Ensure you have the necessary user tier to perform this action.

```http
POST https://api.crisp.chat/v1/website
{
  "name": "My Website",
  "domain": "example.com"
}
```

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

### Get Ongoing Call Session For Conversation

Source: https://docs.crisp.chat/references/rest-api/v1

Gets the ongoing audio/video call session for conversation.

```APIDOC
## GET /v1/website/{website_id}/conversation/{session_id}/call

### Description
Gets the ongoing audio/video call session for conversation.

### Method
GET

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/call

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (200 OK)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **call_id** (string) - Call session identifier (if any call ongoing)
```

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

### Get A Conversation Endpoint

Source: https://docs.crisp.chat/references/rest-api/v1

This snippet shows the GET endpoint for retrieving a specific conversation session. Replace `website_id` and `session_id` with your actual values.

```http
GET https://api.crisp.chat/v1/website/website_id/conversation/session_id
```

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

### Create Website

Source: https://docs.crisp.chat/references/rest-api/v1

Creates a new website. Requires the website's name and domain for creation.

```APIDOC
## POST /v1/website

### Description
Creates a new website.

### Method
POST

### Endpoint
/v1/website

### Parameters
#### Request Body
- **name** (string) - Required - Website name
- **domain** (string) - Required - Website domain
```

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

### Get A Message API Endpoint

Source: https://docs.crisp.chat/references/rest-api/v1

This snippet shows the HTTP GET request to retrieve a message. Ensure you replace `website_id` and `session_id` with your specific values. The `fingerprint` is the unique identifier for the message.

```http
GET https://api.crisp.chat/v1/website/website_id/conversation/session_id/message/fingerprint
```

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

### Check If Helpdesk Exists

Source: https://docs.crisp.chat/references/rest-api/v1

Checks if a helpdesk exists for a website, indicating if it has been initialized.

```APIDOC
## Check If Helpdesk Exists
HEAD
/v1/website/{website_id}/helpdesk

### Description
Checks if helpdesk exists for website (ie. if it has been initialized).

### Method
HEAD

### Endpoint
/v1/website/{website_id}/helpdesk

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

### Response
#### Success Response (200 OK)
(No specific response body details provided in source)

#### Error Responses
- 402 Payment Required
- 403 Forbidden
- 404 Not Found
```

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

### Import External Helpdesk To Locale

Source: https://docs.crisp.chat/references/rest-api/v1

Imports an external helpdesk into Crisp for a specified locale. This process is asynchronous.

```APIDOC
## Import External Helpdesk To Locale

### Description
Imports a whole external helpdesk to Crisp, as a Crisp Helpdesk. The import crawler pipeline is asynchronous.

### Method
POST

### Endpoint
/v1/website/{website_id}/helpdesk/locale/{locale}/import

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **locale** (string) - Required - The locale code

#### Request Body
- **helpdesk_url** (string) - Required - URL of the external helpdesk to import
- **detect_locales** (boolean) - Optional - Whether to attempt to auto-detect imported article locales, or use the main locale code for all articles (`false` by default)
- **other_locales** (array[string]) - Optional - Auto-detected locale codes to restrict import to, in addition to the main locale code (ISO 639-1)

### Response
#### Success Response (202 Accepted)
Indicates that the import process has been successfully initiated.
```

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

### Get People Statistics

Source: https://docs.crisp.chat/references/rest-api/v1

Resolves the amount of people stored in the CRM.

```APIDOC
## GET /v1/website/{website_id}/people/stats

### Description
Resolves the amount of people stored in the CRM.

### Method
GET

### Endpoint
/v1/website/{website_id}/people/stats

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

### Response
#### Success Response (200)
- **data** (object)
  - **total** (number) - Total number of people
```

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

### List Suggested People Data Keys

Source: https://docs.crisp.chat/references/rest-api/v1

Lists suggested data keys for people.

```APIDOC
## GET /v1/website/{website_id}/people/suggest/data/{page_number}

### Description
Lists suggested data keys for people.

### Method
GET

### Endpoint
/v1/website/{website_id}/people/suggest/data/{page_number}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **page_number** (string) - Optional - The page number (paging in data list)

### Response
#### Success Response (200)
- **data** (array[object])
  - **key** (string) - Data key value
  - **count** (number) - Number of occurrences of this data key
```

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

### Get Verify Status For Conversation

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves the verification status of a conversation.

```APIDOC
## GET /v1/website/{website_id}/conversation/{session_id}/verify

### Description
Resolves conversation verify status.

### Method
GET

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/verify

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (200)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **verified** (boolean) - Verify status
  - **verifications** (array[object]) - Verified identities
    - **identity** (enum[string]) - Verified identity (Values: `email`)
    - **method** (enum[string]) - Verification method (Values: `link`, `sdk`, `api`, `dkim`, `spf`)
    - **annotation** (string) - Annotation of verified identity (if any)
```

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

### Initiate Browsing Session

Source: https://docs.crisp.chat/references/rest-api/v1

Use this endpoint to initiate a browsing session for a conversation. This is used to ask a client to prepare for a streamed browsing session and request acknowledgement.

```HTTP
POST /v1/website/{website_id}/conversation/{session_id}/browsing
```

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

### Get A Website Operator

Source: https://docs.crisp.chat/references/rest-api/v1

Resolves a given website operator by their user ID.

```APIDOC
## Get A Website Operator
GET
/v1/website/{website_id}/operator/{user_id}

### Description
Resolves a given website operator.

### Method
GET

### Endpoint
/v1/website/{website_id}/operator/{user_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **user_id** (string) - Required - The user identifier for operator

### Response
#### Success Response (200 OK)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **user_id** (string) - User identifier
  - **email** (string) - User email
  - **avatar** (string) - User avatar
  - **first_name** (string) - User first name
  - **last_name** (string) - User last name
  - **role** (enum[string]) - User role. Values: `owner`, `member`
  - **title** (string) - User title (if any)
  - **availability** (enum[string]) - User availability. Values: `online`, `away`, `offline`
  - **has_token** (boolean) - Whether operator has Two Factor Authentication enabled or not

#### Error Responses
- 403 Forbidden
- 404 Not Found
```

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

### Get Conversation Routing Assign

Source: https://docs.crisp.chat/references/rest-api/v1

Resolves assigned operator for conversation routing.

```APIDOC
## Get Conversation Routing Assign

### Description
Resolves assigned operator for conversation routing.

### Method
GET

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/routing

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (200 OK)
#### Response Data
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **assigned** (object) - Assigned operator (if any)
    - **user_id** (string) - Operator user identifier

#### Error Responses
- 402 Payment Required
- 403 Forbidden
- 404 Not Found
```

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

### Create A New Campaign

Source: https://docs.crisp.chat/references/rest-api/v1

Creates a new campaign for a given website.

```APIDOC
## POST /v1/website/{website_id}/campaign

### Description
Creates a new campaign.

### Method
POST

### Endpoint
/v1/website/{website_id}/campaign

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

#### Request Body
- **type** (enum[string]) - Required - Campaign type. Values: `one-shot`, `automated`
- **name** (string) - Required - Campaign name
```

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

### Create A New Campaign Template

Source: https://docs.crisp.chat/references/rest-api/v1

Creates a new campaign template for a website, requiring a name and format.

```APIDOC
## Create A New Campaign Template

### Description
Creates a new campaign template.

### Method
POST

### Endpoint
/v1/website/{website_id}/campaigns/template

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

#### Request Body
- **name** (string) - Required - Template name
- **format** (enum[string]) - Required - Template format (`markdown`, `html`)

### Response
#### Success Response (201 Created)
(Response body not specified in source)
#### Error Responses
- 403 Forbidden
- 404 Not Found
- 409 Conflict
```

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

### List Connect Websites Since Date

Source: https://docs.crisp.chat/references/rest-api/v1

Lists websites linked, unlinked, or updated for a connected plugin since a specified date. Useful for differential updates.

```http
GET https://api.crisp.chat/v1/plugin/connect/websites/since?date_since=2023-01-01T12:00:00Z&filter_configured=0&include_plan=0
```

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

### List All Connect Websites

Source: https://docs.crisp.chat/references/rest-api/v1

Lists all websites linked to a connected plugin. Supports pagination and filtering by configured plugins or inclusion of plan details.

```http
GET https://api.crisp.chat/v1/plugin/connect/websites/all/page_number?filter_configured=0&include_plan=0
```

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

### Get People Subscription Status

Source: https://docs.crisp.chat/references/rest-api/v1

Resolves subscription status for people (subscribed or unsubscribed).

```APIDOC
## Get People Subscription Status

### Description
Resolves subscription status for people (subscribed or unsubscribed).

### Method
GET

### Endpoint
/v1/website/{website_id}/people/subscription/{people_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **people_id** (string) - Required - The people identifier (also allowed: people email)

### Response
#### Success Response (200)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **email** (boolean) - Whether people is subscribed to emails or not
```

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

### Get Website Inbox

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves details of a specific website inbox, including its configuration and timestamps.

```APIDOC
## Get Website Inbox

### Description
Resolves inbox for website.

### Method
GET

### Endpoint
/v1/website/{website_id}/inbox/{inbox_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **inbox_id** (string) - Required - The inbox identifier

### Response
#### Success Response (200 OK)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **inbox_id** (string) - Inbox identifier
  - **name** (string) - Inbox name
  - **emoji** (string) - Inbox emoji
  - **order** (number) - Inbox order
  - **operators** (array[string]) - Operator user identifiers (members of the inbox)
  - **operator** (enum[string]) - Boolean operator used on conditions (Values: `and`, `or`)
  - **conditions** (array[object]) - Filtering conditions
    - **model** (enum[string]) - Filter model (Values: `session`)
    - **criterion** (string) - Filter criterion (in model)
    - **operator** (enum[string]) - Filter operator (Values: `eq`, `neq`, `gte`, `lte`, `gt`, `lt`)
    - **query** (array[string]) - Filter query terms
  - **created_at** (number) - Inbox creation timestamp
  - **updated_at** (number) - Inbox update timestamp

#### Error Responses
402 Payment Required
403 Forbidden
404 Not Found
```

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

### List All Connect Websites

Source: https://docs.crisp.chat/references/rest-api/v1

Lists all websites linked to a connected plugin. Supports pagination and filtering by configured plugins and inclusion of plan details.

```APIDOC
## GET /v1/plugin/connect/websites/all/{page_number}

### Description
Lists all websites linked to connected plugin.

### Method
GET

### Endpoint
/v1/plugin/connect/websites/all/{page_number}

### Parameters
#### Path Parameters
- **page_number** (string) - Optional - The page number (paging if many websites)

#### Query Parameters
- **filter_configured** (string) - Optional - Restrict to configured plugins only (`1` or `0`)
- **include_plan** (string) - Optional - Whether to include the plan subscription in the listed websites (`1` or `0`, defaults to `0`)

### Response
#### Success Response (200 OK)
- **error** (boolean)
- **reason** (string)
- **data** (array[object])
  - **website_id** (string) - Website identifier
  - **price** (number) - Plugin price (in platform-wide currency)
  - **token** (string) - Subscription secret token (used to authenticate against external configuration forms)
  - **settings** (object) - Plugin settings for website
  - **plan** (object) - Plan that the website is subscribed to (if requested)
    - **id** (string) - Plan identifier
    - **name** (string) - Plan name
    - **trialing** (boolean) - Whether the plan is trialing

#### Error Responses
- **206 Partial Content**
```

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

### Get People Data

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves all stored data associated with a specific person within a website.

```APIDOC
## GET /v1/website/{website_id}/people/data/{people_id}

### Description
Gets stored data for people.

### Method
GET

### Endpoint
/v1/website/{website_id}/people/data/{people_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **people_id** (string) - Required - The people identifier (also allowed: people email)

### Response
#### Success Response (200 OK)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **data** (object) - People data
```

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

### Subscribe Website To Plugin

Source: https://docs.crisp.chat/references/rest-api/v1

Subscribes a specified website to a given plugin. This action initiates a subscription for the website to use the features of the selected plugin.

```APIDOC
## POST /v1/plugins/subscription/{website_id}

### Description
Subscribes a given website to a given plugin.

### Method
POST

### Endpoint
/v1/plugins/subscription/{website_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

#### Request Body
- **plugin_id** (string) - Required - Plugin identifier to subscribe to
```

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

### Get Conversation Relations

Source: https://docs.crisp.chat/references/rest-api/v1

Resolves and retrieves conversation relations, including parent and child conversations.

```APIDOC
## Get Conversation Relations

### Description
Resolves conversation relations (related conversations: parents and children, if any).

### Method
GET

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/relations

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (200 OK)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **conversations** (object) - Related conversations
    - **parent** (string) - Parent session identifier (if any)
    - **children** (array[string]) - Child session identifiers
```

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

### Get Conversation State

Source: https://docs.crisp.chat/references/rest-api/v1

Resolves and retrieves the current state of a conversation (pending, unresolved, or resolved).

```APIDOC
## Get Conversation State

### Description
Resolves conversation state (resolved, unresolved or pending).

### Method
GET

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/state

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (200 OK)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **state** (enum[string]) - Conversation state (Values: `pending`, `unresolved`, `resolved`)
```

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

### Initiate Browsing Session For Conversation

Source: https://docs.crisp.chat/references/rest-api/v1

Initiates a browsing session for a conversation. Used to ask a client to prepare for a streamed browsing session for all open tabs, and request acknowledgement of when the client is ready to accept browsing stream actions.

```APIDOC
## POST /v1/website/{website_id}/conversation/{session_id}/browsing

### Description
Initiates browsing session for conversation. Used to ask a client to prepare for a streamed browsing session for all open tabs, and request acknowledgement of when the client is ready to accept browsing stream actions (one acknowledgement per tab).

### Method
POST

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/browsing

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (201 Created)
(No specific fields documented)

#### Error Responses
- 402 Payment Required
- 403 Forbidden
- 404 Not Found
```

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

### Get Block Status For Conversation

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves the block status of a conversation, indicating if incoming messages are blocked.

```APIDOC
## GET /v1/website/{website_id}/conversation/{session_id}/block

### Description
Resolves conversation block status.

### Method
GET

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/block

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (200)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **blocked** (boolean) - Block state
```

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

### Get Conversation Participants

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves the external participants (e.g., CC'd emails) for a given conversation.

```APIDOC
## GET /v1/website/{website_id}/conversation/{session_id}/participants

### Description
Resolves conversation participants (external participants, eg. emails to be set in CC).

### Method
GET

### Endpoint
/v1/website/{website_id}/conversation/{session_id}/participants

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (200)
- **error** (boolean)
- **reason** (string)
- **data** (object)
  - **participants** (array[object]) - External participants for conversation
    - **type** (enum[string]) - External participant type (Values: `email`)
    - **target** (string) - External participant target (ie. email address, identifier, etc.)
```

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

### Add Helpdesk Redirection

Source: https://docs.crisp.chat/references/rest-api/v1

Adds a new redirection for the helpdesk within a specified website. Requires source path and target destination.

```APIDOC
## Add Helpdesk Redirection

### Description
Adds a redirection for helpdesk in website.

### Method
POST

### Endpoint
/v1/website/{website_id}/helpdesk/redirection

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier

#### Request Body
- **path** (string) - Required - Redirection source path
- **target** (string) - Required - Redirection destination target path

### Response
#### Success Response (201 Created)
(Response body details not specified in source)
```

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

### Get A Conversation

Source: https://docs.crisp.chat/references/rest-api/v1

Retrieves detailed information about a specific conversation using its website ID and session ID.

```APIDOC
## GET /v1/website/{website_id}/conversation/{session_id}

### Description
Resolves conversation information.

### Method
GET

### Endpoint
/v1/website/{website_id}/conversation/{session_id}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **session_id** (string) - Required - The conversation session identifier

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for an error, if any.
- **data** (object) - Contains the conversation details.
  - **session_id** (string) - Session identifier.
  - **website_id** (string) - Website identifier.
  - **inbox_id** (string) - Inbox identifier.
  - **people_id** (string) - People identifier.
  - **state** (enum[string]) - Conversation state. Values: `pending`, `unresolved`, `resolved`.
  - **status** (enum[number]) - Conversation status (alias of state). Values: `0` (pending), `1` (unresolved), `2` (resolved).
  - **is_verified** (boolean) - Whether the session is verified.
  - **is_blocked** (boolean) - Whether the session is blocked.
  - **availability** (enum[string]) - Visitor availability. Values: `online`, `offline`.
  - **active** (object) - User activity statistics.
    - **now** (boolean) - Whether the user is active right now.
    - **last** (number) - Timestamp of last user activity.
    - **last_message** (string) - Excerpt of the last message.
    - **preview_message** (object) - Preview of the conversation message.
      - **type** (enum[string]) - Preview message type. Values: `text`, `note`, `file`, `animation`, `audio`, `picker`, `field`, `carousel`.
      - **from** (enum[string]) - Preview message sender. Values: `user`, `operator`.
      - **excerpt** (string) - Preview message excerpt.
      - **fingerprint** (number) - Preview message fingerprint.
  - **topic** (string) - Topic for the conversation.
  - **mentions** (array[string]) - Mentioned user identifiers.
  - **verifications** (array[object]) - Verified identities for this conversation.
    - **identity** (enum[string]) - Verified identity. Values: `email`.
    - **method** (enum[string]) - Verification method. Values: `link`, `sdk`, `api`, `dkim`, `spf`.
    - **annotation** (string) - Annotation of verified identity.
  - **participants** (array[object]) - External participants for this conversation.
    - **type** (enum[string]) - External participant type. Values: `email`.
    - **target** (string) - External participant target.
  - **created_at** (number) - Conversation creation timestamp.
  - **updated_at** (number) - Conversation update timestamp.
  - **waiting_since** (number) - Conversation waiting since timestamp.
  - **compose** (object) - Compose states.
    - **operator** (object) - Compose state for operator.
      - **type** (enum[string]) - Compose state type. Values: `start`, `stop`.
      - **excerpt** (string) - Message excerpt for compose state.
      - **timestamp** (number) - Timestamp for compose state.
    - **user** (object) - Compose user information.
      - **user_id** (string) - Compose user identifier.
      - **nickname** (string) - Compose user nickname.
      - **avatar** (string) - Compose user avatar.
      - **automated** (boolean) - Whether compose is automated.
    - **visitor** (object) - Compose state for visitor.
      - **type** (enum[string]) - Compose state type. Values: `start`, `stop`.
      - **excerpt** (string) - Message excerpt for compose state.
      - **timestamp** (number) - Timestamp for compose state.
      - **automated** (boolean) - Whether compose is automated.
  - **unread** (object) - Unread messages counters.
    - **operator** (number) - Unread messages counter for operator.
    - **visitor** (number) - Unread messages counter for visitor.
  - **assigned** (object) - Assigned operator (if any).
    - **user_id** (string) - Operator user identifier.
  - **meta** (object) - Meta-data for conversation.
    - **nickname** (string) - Visitor nickname.
    - **email** (string) - Visitor email.
    - **phone** (string) - Visitor phone.
    - **address** (string) - Visitor address.
    - **subject** (string) - Subject for conversation.
    - **origin** (enum[string]) - Conversation origin. Values: `chat`, `email`, `urn:*`.
    - **ip** (string) - Visitor IP address.
    - **connection** (object) - Connection information.
      - **isp** (string) - ISP name.
      - **asn** (string) - AS number.
    - **data** (object) - Visitor data.
      - **avatar** (string) - Visitor avatar.
    - **device** (object) - Device information.
      - **capabilities** (array[enum[string]]) - Visitor device capabilities. Values: `browsing`, `call`.
      - **geolocation** (object) - Geolocation information for visitor device.

```

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

### List Helpdesk Redirections

Source: https://docs.crisp.chat/references/rest-api/v1

Lists all redirections configured for the helpdesk within a specific website. Supports pagination.

```APIDOC
## List Helpdesk Redirections

### Description
Lists redirections for helpdesk in website.

### Method
GET

### Endpoint
/v1/website/{website_id}/helpdesk/redirections/{page_number}

### Parameters
#### Path Parameters
- **website_id** (string) - Required - The website identifier
- **page_number** (string) - Optional - Page number for redirections paging

### Response
#### Success Response (200 OK, 206 Partial Content)
- **error** (boolean)
- **reason** (string)
- **data** (array[object])
  - **redirection_id** (string) - Redirection identifier
  - **path** (string) - Redirection source path
  - **target** (string) - Redirection destination target path
  - **created_at** (number) - Redirection creation timestamp
  - **updated_at** (number) - Redirection update timestamp
```

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

### List All Active Plan Subscriptions

Source: https://docs.crisp.chat/references/rest-api/v1

Lists all active plan subscriptions across all websites. It includes details about the plan, pricing, trial status, billing period, and associated website and owner information.

```APIDOC
## GET /v1/plans/subscription

### Description
Lists all active plan subscriptions on all websites, linked to payment methods owned by the user, or from websites the user is member of.

### Method
GET

### Endpoint
/v1/plans/subscription

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for an error, if any.
- **data** (array[object]) - An array of active plan subscription objects.
  - **id** (string) - Plan identifier.
  - **name** (string) - Plan name.
  - **price** (number) - Plan price (in platform-wide currency).
  - **trial_days** (number) - Number of days the plan can be tried for free upon first subscription.
  - **since** (string) - Datetime since when the plan is available.
  - **trialing** (boolean) - Whether the plan is trialing.
  - **trial_end** (string) - Date when the plan current trial ends.
  - **trial_end_date** (string) - Date when the plan trial ends, or ended.
  - **bill_period** (enum[string]) - Bill period (monthly or yearly).
  - **bill_valid_until** (string) - Date until which the bill is valid for subscription.
  - **active** (boolean) - Whether the plan is active.
  - **sandbox** (boolean) - Whether the plan is in sandbox mode.
  - **website** (object) - Website details.
    - **id** (string) - Website identifier.
    - **name** (string) - Website name.
    - **domain** (string) - Website domain.
    - **logo** (string) - Website custom logo image URL.
  - **coupon_redeemed** (boolean) - Whether a coupon was redeemed on this plan.
  - **card_id** (string) - Card identifier used to pay the plan subscription.
  - **owner** (object) - Identity of the user responsible for the subscription.
    - **user_id** (string) - User identifier.
    - **email** (string) - User email.
    - **first_name** (string) - User first name.
    - **last_name** (string) - User last name.
```

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

### Get Conversation Routing Assignment

Source: https://docs.crisp.chat/references/rest-api/v1

Resolves the assigned operator for conversation routing. Useful for understanding who is handling a conversation.

```http
GET /v1/website/{website_id}/conversation/{session_id}/routing
```