# Get all leads

**GET /api/v1/leads**

A caller with `leads:readAll` sees every lead in the firm; a caller with `leads:read` only sees leads assigned to them.
An introducer only sees the leads they introduced.


## Servers
- https://api.plannrcrm.com: https://api.plannrcrm.com ()


## Authentication methods
- Personal access token & O auth2


## Parameters


### Query parameters

- **filter[uuid]** (string)
  Filter by a comma separated list of UUIDs.

- **filter[status]** (string)
  Filter by a comma separated list of statuses. Valid options are [new, contacted, pending_call_back, awaiting_client_action, meeting_booked, uncontactable].

- **filter[assigned_account_uuid]** (string)
  Filter by a comma separated list of assigned employee UUIDs. The literal 'unassigned' selects leads with no assignee and may be combined with UUIDs.

- **filter[introducer_uuid]** (string)
  Filter by a comma separated list of introducer UUIDs.

- **filter[source_uuid]** (string)
  Filter by a comma separated list of lead source UUIDs.

- **filter[sub_source_uuid]** (string)
  Filter by a comma separated list of sub-source UUIDs.

- **filter[archived]** (string)
  Whether to include archived leads. Valid options are [exclude, include, only]. Defaults to 'exclude'.

- **filter[promoted]** (string)
  Whether to include leads promoted to clients. Valid options are [exclude, include, only]. Defaults to 'exclude'.

- **filter[name]** (string)
  Partial, case-insensitive match on first name, last name, full name or entity name.

- **filter[custom_field:REFERENCE]** (string)
  Filter by a lead custom field. Example filter[custom_field:enquiry_channel]='Phone'

- **include** (string)
  Comma separated list of relationships to include in the response. Valid relationships are [custom_fields].

- **sort** (string)
  Field to sort by. Valid fields are [created_at, status_changed_at, last_name, status]. Negative sign to denote DESC. Defaults to '-created_at'.

- **per_page** (integer)
  Number of results to return with pagination (Default 15. Max 500).



## Responses
### 200


#### Body: application/json (object)
- **data** (array[object])


### 403
Unauthorized

#### Body: application/json (object)
- **message** (string)
  A human-readable description of the error.


### 422
Validation error

#### Body: application/json (object)
- **message** (string)
  A human-readable description of the error.

- **errors** (object)
  Validation messages keyed by the field that failed.



[Powered by Bump.sh](https://bump.sh)