List the leads of a campaign with their state

GETRequest

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

Responses

200400401403404429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "data": [
    {
      "id": 0,
      "leadId": 0,
      "accountId": 0,
      "state": "pending",
      "connection": "none",
      "replied": true,
      "messagesSent": -9007199254740991,
      "error": "error",
      "lead": {
        "publicId": "publicId",
        "profileUrl": "profileUrl",
        "firstName": "firstName",
        "lastName": "lastName",
        "headline": "headline",
        "companyName": "companyName"
      },
      "lastActionAt": "lastActionAt",
      "finishedAt": "finishedAt"
    }
  ],
  "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 404

The resource does not exist, or belongs to another account.

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"
      }
    ]
  }
}

Path parameters

• idnumberrequired

Query parameters

• limitnumberoptional
  Default: 25
• cursorstringoptional
• statestringoptional
  Allowed values: pending, active, awaiting_accept, paused, finished, failed, stopped, excluded

Returns

Schema shown for 200 · application/json

• dataobject[]
  Show array — 11 properties

  • idnumber
  • leadIdnumber
  • accountIdone of 2 variants
    Show 2 variants

    • number
  • statestring
    Allowed values: pending, active, awaiting_accept, paused, finished, failed, stopped, excluded
  • connectionstring
    Allowed values: none, sent, accepted
  • repliedboolean
  • messagesSentnumber
  • errorstring
  • leadobject
    Show 6 properties

    • publicIdstring
    • profileUrlstring
    • firstNamestring
    • lastNamestring
    • headlinestring
    • companyNamestring
  • lastActionAtone of 2 variants
    Show 2 variants

    • string
  • finishedAtone of 2 variants
    Show 2 variants

    • string
• nextCursorstring