Gestiono
Referencia de APIChats / Conversation List

Get Conversation List by id

GET /v1/conversation-list/:id • validated by `getConversationListByIdSchema`

← Back to full API reference
GET/v1/conversation-list/:idAuthentication required
  • Validated by Zod schema: getConversationListByIdSchema.

Request details

Path params

  • id

    Required path parameter.

Query params

  • includeContacts

    Type: enum

    Example: true

Body fields

No body payload expected for GET endpoints.

Default payloads

Path params

json
{
  "id": 1
}

Query

json
{
  "includeContacts": "true"
}

Sample response

json
{
  "list": "<list>",
  "contactsCount": "<contactsCount>"
}

Test this endpoint now

Use your own credentials and execute a live request directly from this page.

1. Configure authentication for testing

You can test endpoints with signed API keys, a raw Authorization token, or browser cookies. Select one mode and fill in the required fields.

2. Select endpoint

GET/v1/conversation-list/:idAuthentication required

Group: Chats / Conversation List

GET /v1/conversation-list/:id • validated by `getConversationListByIdSchema`

  • Validated by Zod schema: getConversationListByIdSchema.

Path params

  • idrequired

Query params

  • includeContacts
    Type: enum
    Ejemplo: true

3. Prepare request payload

4. Server response

Run a request to inspect the real-time response for your environment.