S2S Contacts

List contact conversations

List the contact's conversations, most recent activity first. Bot-only conversations without human interaction are hidden — exactly the widget's conversation list.

GET

https://api.gleap.io/v3/s2s/contacts/{userId}/conversations

Authorizations

Authorizationstring · headerrequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIdstringrequired

Query parameters

cursorstring

limitnumber<double>

Headers

Gleap-Versionstring

Pin a specific API version; defaults to the current version.

Example: 2026-08-01

Response

application/json

next_cursorstring | nullrequired

has_morebooleanrequired

itemsobject[]required

Show child attributes

idstringrequired

numbernumber<double>

titlestring

typestring

statusstring

closedbooleanrequired

Show 11 more attributes

archivedbooleanrequired

unreadbooleanrequired

ratingnumber<double>

CSAT rating 0-10 given by the contact (rateconversation step or POST …/rating).

workflowActivebooleanrequired

workflowIdstring

assigneeobject | null

Show child attributes

typeenum<string>required

Allowed values: contactagentbotsystem

idstring

namestring

avatarstring

attributesobject

Construct a type with a set of properties K of type T

contactobject

Show child attributes

userIdstring

latestMessageobject

Show child attributes

idstringrequired

conversationIdstringrequired

textstring

authorobjectrequired

Show child attributes

typeenum<string>required

Allowed values: contactagentbotsystem

idstring

namestring

avatarstring

attachmentsobject[]required

Show child attributes

urlstringrequired

namestring

contentTypestring

replyToMessageIdstring

Show 3 more attributes

ratingstring

unreadbooleanrequired

createdAtstring<date-time>required

createdAtstring<date-time>

lastActivityAtstring<date-time>

application/problem+json

Missing, invalid or revoked service account token.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

The addressed resource does not exist in this project.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Idempotency-Key reuse with a different request body.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Rate limit exceeded — honor the Retry-After header.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Any other error, including validation_failed (400) and internal_error (500).

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

Updated November 1, 2026

curl --request GET \
  --url 'https://api.gleap.io/v3/s2s/contacts/{userId}/conversations' \
  --header 'Authorization: Bearer <token>'

{
  "next_cursor": "string",
  "has_more": true,
  "items": [
    {
      "id": "string",
      "number": 0,
      "title": "string",
      "type": "string",
      "status": "string",
      "closed": true,
      "archived": true,
      "unread": true,
      "rating": 0,
      "workflowActive": true,
      "workflowId": "string",
      "assignee": {
        "type": "contact",
        "id": "string",
        "name": "string",
        "avatar": "string"
      },
      "attributes": {},
      "contact": {
        "userId": "string"
      },
      "latestMessage": {
        "id": "string",
        "conversationId": "string",
        "text": "string",
        "author": {
          "type": "contact",
          "id": "string",
          "name": "string",
          "avatar": "string"
        },
        "attachments": [
          {
            "url": "string",
            "name": "string",
            "contentType": "string"
          }
        ],
        "replyToMessageId": "string",
        "rating": "string",
        "unread": true,
        "createdAt": "2026-01-01T12:00:00Z"
      },
      "createdAt": "2026-01-01T12:00:00Z",
      "lastActivityAt": "2026-01-01T12:00:00Z"
    }
  ]
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

{
  "type": "https://docs.gleap.io/s2s/problems/conversation_closed",
  "title": "string",
  "status": 0,
  "code": "conversation_closed",
  "detail": "string",
  "request_id": "req_66c0ffee0000000000000001"
}

Response

application/json

next_cursorstring | nullrequired

has_morebooleanrequired

itemsobject[]required

Show child attributes

idstringrequired

numbernumber<double>

titlestring

typestring

statusstring

closedbooleanrequired

Show 11 more attributes

archivedbooleanrequired

unreadbooleanrequired

ratingnumber<double>

CSAT rating 0-10 given by the contact (rateconversation step or POST …/rating).

workflowActivebooleanrequired

workflowIdstring

assigneeobject | null

Show child attributes

typeenum<string>required

Allowed values: contactagentbotsystem

idstring

namestring

avatarstring

attributesobject

Construct a type with a set of properties K of type T

contactobject

Show child attributes

userIdstring

latestMessageobject

Show child attributes

idstringrequired

conversationIdstringrequired

textstring

authorobjectrequired

Show child attributes

typeenum<string>required

Allowed values: contactagentbotsystem

idstring

namestring

avatarstring

attachmentsobject[]required

Show child attributes

urlstringrequired

namestring

contentTypestring

replyToMessageIdstring

Show 3 more attributes

ratingstring

unreadbooleanrequired

createdAtstring<date-time>required

createdAtstring<date-time>

lastActivityAtstring<date-time>

application/problem+json

Missing, invalid or revoked service account token.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

The addressed resource does not exist in this project.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Idempotency-Key reuse with a different request body.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Rate limit exceeded — honor the Retry-After header.

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

application/problem+json

Any other error, including validation_failed (400) and internal_error (500).

typestringrequired

Example: https://docs.gleap.io/s2s/problems/conversation_closed

titlestringrequired

statusnumberrequired

codestringrequired

Example: conversation_closed

detailstring

request_idstring

Example: req_66c0ffee0000000000000001

{ "next_cursor": "string", "has_more": true, "items": [ { "id": "string", "number": 0, "title": "string", "type": "string", "status": "string", "closed": true, "archived": true, "unread": true, "rating": 0, "workflowActive": true, "workflowId": "string", "assignee": { "type": "contact", "id": "string", "name": "string", "avatar": "string" }, "attributes": {}, "contact": { "userId": "string" }, "latestMessage": { "id": "string", "conversationId": "string", "text": "string", "author": { "type": "contact", "id": "string", "name": "string", "avatar": "string" }, "attachments": [ { "url": "string", "name": "string", "contentType": "string" } ], "replyToMessageId": "string", "rating": "string", "unread": true, "createdAt": "2026-01-01T12:00:00Z" }, "createdAt": "2026-01-01T12:00:00Z", "lastActivityAt": "2026-01-01T12:00:00Z" } ] }

{ "type": "https://docs.gleap.io/s2s/problems/conversation_closed", "title": "string", "status": 0, "code": "conversation_closed", "detail": "string", "request_id": "req_66c0ffee0000000000000001" }