List conversations

GETRequest

curl "https://prestigious-goldfish-661.convex.site/v1/conversations" \
    -H "Authorization: Bearer $REACHIZ_API_KEY"

Responses

200400401403429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "data": [
    {
      "id": 0,
      "accountId": 0,
      "type": "linkedin",
      "correspondent": {
        "name": "name",
        "publicId": "publicId",
        "headline": "headline",
        "profileUrl": "profileUrl",
        "imageUrl": "imageUrl"
      },
      "leadId": 0,
      "campaignId": 0,
      "unread": true,
      "archived": true,
      "starred": true,
      "replied": true,
      "lastMessage": {
        "preview": "preview",
        "fromMe": true,
        "at": "at"
      }
    }
  ],
  "nextCursor": "nextCursor"
}

Response 400

The request is not valid. error.fields lists each problem.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 401

The API key is missing or not valid.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 403

The key lacks the scope this route needs.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 429

Too many requests.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Response 503

The service is busy. Retry with backoff.

application/json

Example responseGenerated from schema

{
  "error": {
    "code": "invalid_request",
    "message": "message",
    "requestId": "requestId",
    "recovery": "recovery",
    "fields": [
      {
        "path": "path",
        "message": "message"
      }
    ]
  }
}

Query parameters

• limitnumberoptional
  Default: 25
• cursorstringoptional
• accountnumberoptional
• campaignnumberoptional
• unreadstringoptional
  Allowed values: true, false

Returns

Schema shown for 200 · application/json

• dataobject[]
  Show array — 11 properties

  • idnumber
  • accountIdnumber
  • typestring
    Allowed values: linkedin, inmail, sales_navigator, recruiter
  • correspondentobject
    Show 5 properties

    • namestring
    • publicIdstring
    • headlinestring
    • profileUrlstring
    • imageUrlstring
  • leadIdone of 2 variants
    Show 2 variants

    • number
  • campaignIdone of 2 variants
    Show 2 variants

    • number
  • unreadboolean
  • archivedboolean
  • starredboolean
  • repliedboolean
  • lastMessageobject
    Show 3 properties

    • previewstring
    • fromMeboolean
    • atstring
• nextCursorstring