--- title: "Get a specific conversation" method: GET path: "/conversations/{convId}" tags: ["conversations"] --- # Get a specific conversation `GET /conversations/{convId}` Retrieves information about a specific conversation. Only the last message is included; use the messages endpoint to retrieve the full message history. **Permission:** `Conversations Read` required. **Monitoring:** Optional. With Monitoring **OFF**, you can only access your own conversations. With Monitoring **ON**, you can access any conversation within your supervision scope. ## Path parameters - `convId` integer, required ## Response `200` Successful operation — the conversation details are returned. - ConversationLight - `conversation_id` integer - `is_sms_write` boolean — True if the user can send an SMS in the conversation - `is_mms_write` boolean — True if the user can send an MMS in the conversation - `type` 'INTERNAL' | 'EXTERNAL' | 'COLLABORATIVE' - `tags` string[] - `star` string[], nullable — Used to filter stars ID - `favorite` boolean — True if the user bookmarked the conversation - `name` string - `purpose` string - `user_list` ConvUserLight - `user_id` integer — The user identifier - `initial` string — The initials of the user - `color` string - `firstname` string — The firstname of the user - `lastname` string — The lastname of the user - `company` string — The company of the user - `concat_name` string - `email` string — The email of the user - `picture` string — The picture of the user - `is_sms_write` boolean — True if the user can send an SMS in the conversation - `is_administrator` boolean - `internal` Member[], nullable — Store internal conversation members - `conversation_user_id` integer - `user` MemberRingover - `user_id` integer - `initial` string - `color` string - `firstname` string - `lastname` string - `company` string - `concat_name` string - `email` string - `picture` string - `is_sms_write` boolean — is not displayed if the user does not have the `is_sms_write` right - `is_administrator` boolean — is not displayed if the user is not an administrator - `ivr` MemberIvr - `id` integer - `name` string - `scenario_id` integer - `color` string - `group` object — Can be `null` (mutually exclusive with ivr and group) - `id` integer — The identifier of the group - `name` string — The name of the group - `color` string - `alphanumeric` string, nullable — Can be `null` if the `number` is filled - `number` FormatNumber - `raw` integer - `country_code` string - `country` string - `e164` string - `international` string - `international_alt` string - `national` string - `national_alt` string - `rfc3966` string - `is_short_code` boolean - `contact` Contact - `contact_id` integer - `is_shared` boolean - `im_owner` string - `social_service` string, nullable - `social_service_id` string - `social_profile_url` string, nullable - `social_data` string, nullable - `firstname` string - `lastname` string - `company` string - `concat_name` string - `color` string - `initial` string - `profile_picture` string, nullable - `creation_date` string, date-time - `numbers` integer[], nullable - `picture` string, nullable - `is_administrator` boolean - `external` Member[], nullable — Store external conversation members (is not displayed in case of internal conversation) - `conversation_user_id` integer - `user` MemberRingover - `user_id` integer - `initial` string - `color` string - `firstname` string - `lastname` string - `company` string - `concat_name` string - `email` string - `picture` string - `is_sms_write` boolean — is not displayed if the user does not have the `is_sms_write` right - `is_administrator` boolean — is not displayed if the user is not an administrator - `ivr` MemberIvr - `id` integer - `name` string - `scenario_id` integer - `color` string - `group` object — Can be `null` (mutually exclusive with ivr and group) - `id` integer — The identifier of the group - `name` string — The name of the group - `color` string - `alphanumeric` string, nullable — Can be `null` if the `number` is filled - `number` FormatNumber - `raw` integer - `country_code` string - `country` string - `e164` string - `international` string - `international_alt` string - `national` string - `national_alt` string - `rfc3966` string - `is_short_code` boolean - `contact` Contact - `contact_id` integer - `is_shared` boolean - `im_owner` string - `social_service` string, nullable - `social_service_id` string - `social_profile_url` string, nullable - `social_data` string, nullable - `firstname` string - `lastname` string - `company` string - `concat_name` string - `color` string - `initial` string - `profile_picture` string, nullable - `creation_date` string, date-time - `numbers` integer[], nullable - `picture` string, nullable - `is_administrator` boolean - `unread_messages_count` integer - `last_message` Message - `message_id` integer - `mdr_uuid` string — is displayed for external conversations - `thread` object - `thread_uuid` string - `conversation_id_linked` integer - `conversation_sms_id_linked` integer - `nb_response` integer - `buffer_section` integer - `conversation_id` integer - `conversation_user_id` integer - `user` UserLight - `user_id` integer — The user identifier - `team_id` integer — The team identifier of the user - `initial` string — The initials of the user - `color` string - `firstname` string — The firstname of the user - `lastname` string — The lastname of the user - `company` string — The company of the user - `email` string — The email of the user - `picture` string — The picture of the user - `concat_name` string - `contact` Contact - `contact_id` integer - `is_shared` boolean - `im_owner` string - `social_service` string, nullable - `social_service_id` string - `social_profile_url` string, nullable - `social_data` string, nullable - `firstname` string - `lastname` string - `company` string - `concat_name` string - `color` string - `initial` string - `profile_picture` string, nullable - `creation_date` string, date-time - `numbers` integer[], nullable - `number` FormatNumber - `raw` integer - `country_code` string - `country` string - `e164` string - `international` string - `international_alt` string - `national` string - `national_alt` string - `rfc3966` string - `is_short_code` boolean - `buffer` string — Content of the message - `total_price` integer — Is `null` if the conversation is internal - `total_plan` integer — Is `null` if the conversation is internal - `is_failed` boolean - `nb_fragments` integer — Depends on the number of characters sent - `direction` 'IN' | 'OUT', nullable - `is_archived` boolean - `archive_date` string, date-time - `creation_date` string, date-time - `update_date` string, date-time - `total_messages_count` integer - `is_archived` boolean — Archived (true) or not (false) - `adminrules` Adminrulesitems[] — Permissions of the conversation's administrators (Chat only) - `can_invite` boolean - `can_leave` boolean - `can_kick` boolean - `can_join` boolean - `can_view_history` boolean - `can_thread_in` integer — ID of the SMS conversation commented by the conversation - `is_commented_by` integer — ID of the associated comment conversation - `unread_comment` integer — Latest unread message of the conversation - `creation_date` string, date-time - `update_date` string, date-time ## Other responses - `400` — Invalid conversation ID format. - `401` — Unauthorized — missing or invalid API token, or missing `Conversations Read` permission. - `404` — Conversation not found — no conversation matches the provided ID, or you do not have access. - `500` — Internal server error. --- [API](https://skmtc.net/ringover/apis/ringover-public-api.md) · [All operations](https://skmtc.net/ringover/apis/ringover-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringover/ringover-public-api/revisions/9da73dd2f99e/schema)