List Leads

Display a paginated list of leads belonging to the authenticated user's company. A lead is a person who signed up for one of the company's resources (lead-magnets).

The leads are ordered by their creation date in descending order, meaning the most recently created leads will appear first.

Use the resource query parameter to only return the leads of a single resource — pass the id of a resource as returned by the resources endpoints.

Query Params
integer
≥ 1

The page parameter is used for pagination. It is optional and must be an integer greater than or equal to 1. If not provided, the first page will be returned.

integer
1 to 50

The per_page parameter is used to specify the number of results to return per page. It is optional and must be an integer between 1 and 50. If not provided, the default value of 15 will be used.

string

Filter the leads by the resource they signed up for. Pass the id of a resource as returned by the resources endpoints. If the given resource does not belong to your company, a validation error is returned.

string

Expand related resources.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json