Skip to main content
GET
/
api
/
v1
/
leads
Error
A valid request URL is required to generate request examples
{
  "ok": "<unknown>",
  "meta": {
    "requestId": "<string>",
    "serverTime": "2023-11-07T05:31:56Z"
  },
  "data": {
    "items": [
      {
        "id": "<string>",
        "legacy": {
          "convexId": "<string>",
          "goldenLeadId": 123
        },
        "projectName": "<string>",
        "companyName": "<string>",
        "description": "<string>",
        "location": {
          "raw": "<string>",
          "city": "<string>",
          "state": "<string>"
        },
        "scores": {
          "strategicScore": 123,
          "validationTier": "PLATINUM",
          "validationScore": 123,
          "goNoGoScore": 123
        },
        "updatedAt": "2023-11-07T05:31:56Z",
        "following": true,
        "lastViewedAt": "2023-11-07T05:31:56Z",
        "pipelineStage": "<string>"
      }
    ],
    "page": {
      "pageSize": 250,
      "nextCursor": "<string>",
      "totalCount": 1
    }
  }
}

Query Parameters

filter
string

URL-encoded JSON filter object

include
string

Comma-separated expansions to include (finite allowlist)

fields
string

Field mask for partial responses

cursor
string | null

Opaque pagination cursor

pageSize
integer
default:50
Required range: 1 <= x <= 500

Response

OK

ok
any
required
meta
object
required
data
object
required