GET
/
api
/
leads
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 123,
      "email": "jsmith@example.com",
      "phone_number": "<string>",
      "metadata": "<any>",
      "modified_time": "2023-11-07T05:31:56Z",
      "created_time": "2023-11-07T05:31:56Z",
      "status": "UNKNOWN",
      "status_reason": "UNKNOWN",
      "lead_type": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string | null
Example:

"http://api.example.org/accounts/?page=2"