Get all leads
GET {{baseUrl}}/leads?limit=<integer>&start=<integer>&archived_status=<string>&owner_id=<integer>&person_id=<integer>&organization_id=<integer>&filter_id=<integer>&sort=<string>
Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using limit and start query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the Deals endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. | |
start | string | For pagination, the position that represents the first result for the page | |
archived_status | string | Filtering based on the archived status of a lead. If not provided, All is used. | |
owner_id | string | If supplied, only leads matching the given user will be returned. However, filter_id takes precedence over owner_id when supplied. | |
person_id | string | If supplied, only leads matching the given person will be returned. However, filter_id takes precedence over person_id when supplied. | |
organization_id | string | If supplied, only leads matching the given organization will be returned. However, filter_id takes precedence over organization_id when supplied. | |
filter_id | string | The ID of the filter to use | |
sort | string | The field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"success":true,"data":[{"id":"adf21080-0e10-11eb-879b-05d71fb426ec","title":"Jane Doe Lead","owner_id":1,"creator_id":1,"label_ids":["f08b42a0-4e75-11ea-9643-03698ef1cfd6","f08b42a1-4e75-11ea-9643-03698ef1cfd6"],"person_id":1092,"organization_id":null,"source_name":"API","origin":"API","origin_id":null,"channel":52,"channel_id":"Jun23 Billboards","is_archived":false,"was_seen":false,"value":{"amount":999,"currency":"USD"},"expected_close_date":null,"next_activity_id":1,"add_time":"2020-10-14T11:30:36.551Z","update_time":"2020-10-14T11:30:36.551Z","visible_to":"3","cc_email":"company+1+leadntPaYKA5QRxXkh6WMNHiGh@dev.pipedrivemail.com"}]}