List lead lists

GETRequest

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

Responses

200400401403429503

Response 200

Success

application/json

Example responseGenerated from schema

{
  "data": [
    {
      "id": 0,
      "name": "name",
      "type": "people",
      "leadCount": -9007199254740991,
      "createdAt": "createdAt"
    }
  ],
  "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

Returns

Schema shown for 200 · application/json

• dataobject[]
  Show array — 5 properties

  • idnumber
  • namestring
  • typestring
    Allowed values: people, companies, events, groups, unknown
  • leadCountnumber
  • createdAtstring
• nextCursorstring