List Leads

GET

/api/leads

curl --request GET \
  --url 'http://localhost:8000/api/leads?limit=200&offset=0&order_by=score%20DESC' \
  --header 'Authorization: Bearer <token>'

• Local API (uvicorn)
• Docker Compose (nginx front)

Authorizations

• OAuth2PasswordBearer

Parameters

Query Parameters

status

Any of:

string

string

null

null

city

Any of:

string

string

null

null

source

Any of:

string

string

null

null

score_min

Any of:

integer

integer

null

null

score_max

Any of:

integer

integer

null

null

tier

Any of:

string

string

null

null

search

Any of:

string

string

null

null

workspace_id

Any of:

string

string

null

null

has_email

Any of:

boolean

boolean

null

null

has_phone

Any of:

boolean

boolean

null

null

company_size

Any of:

string

string

null

null

limit

Limit

integer

default: 200

offset

Offset

integer

0

order_by

Order By

string

default: score DESC

Header Parameters

x-workspace-id

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

Example^generated

example

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}