Leads.list

Returns all defined Leads

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted Leads are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

filter

object

optional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

filter-op

object

optional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Responses

🟢200OK

application/json

list of Leads

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (Lead) {51}]

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

optional

Creation time.

Example:

2019-01-01T00:00:00

currency_exchange_rates_list

string <uri>

optional

Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.

lead_source

string <uri>

optional

Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.

lead_type

string <uri>

required

Relation to LeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadType' object for properties.

owner

string <uri>

optional

Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.

reason_of_close

string <uri>

optional

Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.

step

string <uri>

required

Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties.

unit

string <uri>

required

Relation to SalesUnit. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'SalesUnit' object for properties.

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

description

string

optional

Multi-line text input field.

Example:

string

is_archived

boolean

optional

Boolean value.

Example:

false

label_flag

enum<string>

optional

Opportunity label flag.

Options:
Priority = 1 (0b001)
Hot = 2 (0b010)
Stalled = 4 (0b100)

Allowed values:

124

Example:

lead_source_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

lead_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

name

string

required

Name of the entity and its default text representation.

Example:

string

owner_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quick_account_email

string

optional

Simple text input field.

Example:

string

quick_account_name

string

optional

Simple text input field.

Example:

string

quick_account_phone

string

optional

Simple text input field.

Example:

string

quick_contact_name

string

optional

Simple text input field.

Example:

string

quick_email

string

optional

Simple text input field.

Example:

string

quick_phone

string

optional

Simple text input field.

Example:

string

ranking

integer <int32>

optional

Qualitative ranking of the opportunity.

Example:

reason_of_close_description

string

optional

Multi-line text input field.

Example:

string

reason_of_close_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

share_mode

enum<integer>

optional

Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit

Allowed values:

0123

Example:

step_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

table_name

string

read-onlyrequired

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

primary_contact

string <uri>

optional

Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.

primary_account

string <uri>

optional

Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.

contact_relations

array[string <uri>]

optional

Relations to Contacts.

account_relations

array[string <uri>]

optional

Relations to Accounts.

status

enum<integer>

read-onlyrequired

Integer enum value: 1 - Open, 2 - Lost

Allowed values:

Example:

sharing_units

array[string <uri>]

optional

Relations to SalesUnits.

sharing_clients

array[string <uri>]

optional

Relations to Clients.

documents

array[string <uri>]

optional

Relations to CloudObjects.

tags

array[string <uri>]

optional

Relations to Tags.

static_profiles

array[string <uri>]

optional

Relations to Profiles.

qualify_date

string <date-time>

optional

Example:

2019-01-01T00:00:00

days_in_step

integer <int32>

required

Example:

is_favorite

boolean

required

Example:

false

lost_date

string <date-time>

optional

Example:

2019-01-01T00:00:00

formatted_name

string

required

Example:

string

scoring

object

optional

modified_by_user

string <date-time>

optional

Example:

2019-01-01T00:00:00

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

Example

{
    "success": true,
    "data": [
        {
            "is_delete_protected": false,
            "id": "01234567-abcd-dcba-ffff-000000000000",
            "is_deleted": false,
            "modified": "2019-01-01T00:00:00",
            "created": "2019-01-01T00:00:00",
            "currency_exchange_rates_list": "http://example.com",
            "lead_source": "http://example.com",
            "lead_type": "http://example.com",
            "owner": "http://example.com",
            "reason_of_close": "http://example.com",
            "step": "http://example.com",
            "unit": "http://example.com",
            "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
            "description": "string",
            "is_archived": false,
            "label_flag": 1,
            "lead_source_id": "01234567-abcd-dcba-ffff-000000000000",
            "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
            "name": "string",
            "owner_id": "01234567-abcd-dcba-ffff-000000000000",
            "quick_account_email": "string",
            "quick_account_name": "string",
            "quick_account_phone": "string",
            "quick_contact_name": "string",
            "quick_email": "string",
            "quick_phone": "string",
            "ranking": 1,
            "reason_of_close_description": "string",
            "reason_of_close_id": "01234567-abcd-dcba-ffff-000000000000",
            "share_mode": 0,
            "step_id": "01234567-abcd-dcba-ffff-000000000000",
            "table_name": "string",
            "unit_id": "01234567-abcd-dcba-ffff-000000000000",
            "revision": 1,
            "primary_contact": "http://example.com",
            "primary_account": "http://example.com",
            "contact_relations": [
                "http://example.com"
            ],
            "account_relations": [
                "http://example.com"
            ],
            "status": 1,
            "sharing_units": [
                "http://example.com"
            ],
            "sharing_clients": [
                "http://example.com"
            ],
            "documents": [
                "http://example.com"
            ],
            "tags": [
                "http://example.com"
            ],
            "static_profiles": [
                "http://example.com"
            ],
            "qualify_date": "2019-01-01T00:00:00",
            "days_in_step": 1,
            "is_favorite": false,
            "lost_date": "2019-01-01T00:00:00",
            "formatted_name": "string",
            "scoring": {},
            "modified_by_user": "2019-01-01T00:00:00"
        }
    ],
    "page_info": {
        "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
        "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
        "has_previous_page": true,
        "has_next_page": true
    }
}

🔴500Server Error

Request

Request samples

Responses