Sign in
latestOpenAPI 3.1.02026-08-13233474.8 KB

e920ac8ed225

Leads

Get Leads

Get a list of leads scoped by the query parameters.

get/leads

Query parameters

idstring

Lead ID

Lead ID

phoneNumberstring

The Lead's phone number. Represented as an E.164 Format (i.e +15554441234 for (555) 444-1234 in the US).

The Lead's phone number. Represented as an E.164 Format (i.e +15554441234 for (555) 444-1234 in the US).

organizationIdstring

Organization ID.

Organization ID.

groupIdstring

A Group ID. This will return a lead that has this group inside of the activeGroupIds array. To also include inactive groups, use the searchInactiveGroups query parameter.

A Group ID. This will return a lead that has this group inside of the activeGroupIds array. To also include inactive groups, use the searchInactiveGroups query parameter.

leadStatusInGroup'active' | 'inactive' | 'all'

When a groupId is passed, this determines whether we look in the activeGroupIds array, inactiveGroupIds array, or both. Defaults to active.

When a groupId is passed, this determines whether we look in the activeGroupIds array, inactiveGroupIds array, or both. Defaults to active.

cursorstring

Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.

Cursor for start of next set of items. Pass whatever you receive from the response to get the next elements in the array.

limitnumber

Limit of items per page.

Limit of items per page.

Response

Returns a list of leads that match the query parameters.

cursorstring nullable required

Cursor for start of next set of items. If there were no items to return with the last cursor you passed, this will return null.

hasMoreboolean required

Whether there are more items to load past this cursor.