--- title: "Conversations List" method: GET path: "/v1/workspaces/{workspace_id}/conversations" tags: ["Conversations"] --- # Conversations List `GET /v1/workspaces/{workspace_id}/conversations` ## Request - Base URL: `https://api.oxvo.com` - URL: `https://api.oxvo.com/v1/workspaces/{workspace_id}/conversations` - Auth: API key in header `api_access_token` List all the conversations with pagination ## Query parameters - `assignee_type` 'me' | 'unassigned' | 'all' | 'assigned' - `status` 'all' | 'open' | 'resolved' | 'pending' | 'snoozed' - `q` string - `inbox_id` integer - `team_id` integer - `labels` string[] - `page` integer ## Response `200` Success - ConversationList - `data` object - `meta` object - `mine_count` number - `unassigned_count` number - `assigned_count` number - `all_count` number - `payload` object[]: array of conversations - `id` number: ID of the conversation - `messages` Message[] - `id` number: The ID of the message - `content` string: The text content of the message - `account_id` number: The ID of the account - `inbox_id` number: The ID of the inbox - `conversation_id` number: The ID of the conversation - `message_type` 0 | 1 | 2 | 3: The type of the message - `created_at` integer: The time at which message was created - `updated_at` union: The time at which message was updated - integer - string - `private` boolean: The flags which shows whether the message is private or not - `status` 'sent' | 'delivered' | 'read' | 'failed' | 'null', nullable: The status of the message - `source_id` string, nullable: The source ID of the message - `content_type` 'text' | 'input_text' | 'input_textarea' | 'input_email' | 'input_select' | 'cards' | 'form' | 'article' | 'incoming_email' | 'input_csat' | 'integrations' | 'sticker' | 'voice_call' | 'null', nullable: The type of the template message - `content_attributes` object: The content attributes for each content_type - `sender_type` 'Contact' | 'User' | 'AgentBot' | 'Captain::Assistant' | 'null', nullable: The type of the sender - `sender_id` number, nullable: The ID of the sender - `external_source_ids` object: The external source IDs of the message - `additional_attributes` object: The additional attributes of the message - `processed_message_content` string, nullable: The processed message content - `sentiment` object, nullable: The sentiment of the message - `conversation` object, nullable: The conversation object - `attachment` object, nullable: The file object attached to the image - `sender` object: User/Agent/AgentBot object - `account_id` number: Account Id - `uuid` string: UUID of the conversation - `additional_attributes` object: The object containing additional attributes related to the conversation - `agent_last_seen_at` number: The last activity at of the agent - `assignee_last_seen_at` number: The last activity at of the assignee - `can_reply` boolean: Whether the conversation can be replied to - `contact_last_seen_at` number: The last activity at of the contact - `custom_attributes` object: The object to save custom attributes for conversation, accepts custom attributes key and value - `inbox_id` number: ID of the inbox - `labels` string[]: The labels of the conversation - `muted` boolean: Whether the conversation is muted - `snoozed_until` number, nullable: The time at which the conversation will be unmuted - `status` 'open' | 'resolved' | 'pending': The status of the conversation - `created_at` number: The time at which conversation was created - `updated_at` number: The time at which conversation was updated - `timestamp` number: The time at which conversation was created - `first_reply_created_at` number, nullable: The time at which the first reply was created - `unread_count` number: The number of unread messages - `last_non_activity_message` Message - `id` number: The ID of the message - `content` string: The text content of the message - `account_id` number: The ID of the account - `inbox_id` number: The ID of the inbox - `conversation_id` number: The ID of the conversation - `message_type` 0 | 1 | 2 | 3: The type of the message - `created_at` integer: The time at which message was created - `updated_at` union: The time at which message was updated - integer - string - `private` boolean: The flags which shows whether the message is private or not - `status` 'sent' | 'delivered' | 'read' | 'failed' | 'null', nullable: The status of the message - `source_id` string, nullable: The source ID of the message - `content_type` 'text' | 'input_text' | 'input_textarea' | 'input_email' | 'input_select' | 'cards' | 'form' | 'article' | 'incoming_email' | 'input_csat' | 'integrations' | 'sticker' | 'voice_call' | 'null', nullable: The type of the template message - `content_attributes` object: The content attributes for each content_type - `sender_type` 'Contact' | 'User' | 'AgentBot' | 'Captain::Assistant' | 'null', nullable: The type of the sender - `sender_id` number, nullable: The ID of the sender - `external_source_ids` object: The external source IDs of the message - `additional_attributes` object: The additional attributes of the message - `processed_message_content` string, nullable: The processed message content - `sentiment` object, nullable: The sentiment of the message - `conversation` object, nullable: The conversation object - `attachment` object, nullable: The file object attached to the image - `sender` object: User/Agent/AgentBot object - `last_activity_at` number: The last activity at of the conversation - `priority` string, nullable: The priority of the conversation - `waiting_since` number, nullable: The time at which the conversation was waiting - `sla_policy_id` number, nullable: The ID of the SLA policy - `applied_sla` object: The applied SLA - `sla_events` object[] - `meta` object - `sender` object - `additional_attributes` object: The additional attributes of the sender - `availability_status` string: The availability status of the sender - `email` string, nullable: The email of the sender - `id` number: ID fo the sender - `name` string: The name of the sender - `phone_number` string, nullable: The phone number of the sender - `blocked` boolean: Whether the sender is blocked - `identifier` string, nullable: The identifier of the sender - `thumbnail` string, nullable: Avatar URL of the contact - `custom_attributes` object: The custom attributes of the sender - `last_activity_at` number: The last activity at of the sender - `created_at` number: The created at of the sender - `channel` string: Channel Type - `assignee` User - `id` number - `access_token` string - `account_id` number - `available_name` string - `avatar_url` string - `confirmed` boolean - `display_name` string, nullable - `message_signature` string, nullable - `email` string - `hmac_identifier` string - `inviter_id` number, nullable - `name` string - `provider` string - `pubsub_token` string - `role` 'agent' | 'administrator' - `ui_settings` object - `uid` string - `type` string, nullable - `custom_attributes` object: Available for users who are created through platform APIs and has custom attributes associated. - `accounts` object[] - `id` number - `name` string - `status` string - `active_at` string, date-time, nullable - `role` 'administrator' | 'agent' - `permissions` string[] - `availability` string - `availability_status` string - `auto_offline` boolean - `custom_role_id` number, nullable - `custom_role` object, nullable - `hmac_verified` boolean: Whether the hmac is verified ## Other responses - `400`: Bad Request Error --- [API](https://skmtc.dev/oxvo/apis/oxvo-apis.md) · [All operations](https://skmtc.dev/oxvo/apis/oxvo-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/oxvo/apis/oxvo-apis/revisions/9a8448cbd1fe?raw)