Contacts.list

Returns all defined Contacts

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted Contacts 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

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 Contacts

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (Contact) {60}]

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

contact_type

string <uri>

required

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

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.

owner

string <uri>

required

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.

picture

string <uri>

optional

Relation to CloudObject. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CloudObject' 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.

address

string

optional

Multi-line text input field.

Example:

string

city

string

optional

Simple text input field.

Example:

string

comments

string

optional

Multi-line text input field.

Example:

string

contact_type_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

country

string

optional

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

Example:

string

currency_exchange_rates_list_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

email1

string

optional

Email address.

Example:

string

email2

string

optional

Email address.

Example:

string

email3

string

optional

Email address.

Example:

string

email4

string

optional

Email address.

Example:

string

email5

string

optional

Email address.

Example:

string

first_name

string

optional

Simple text input field.

Example:

string

gender

enum<integer>

optional

Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary

Allowed values:

0123

Example:

is_archived

boolean

optional

Boolean value.

Example:

false

last_name

string

optional

Simple text input field.

Example:

string

middle_name

string

optional

Simple text input field.

Example:

string

owner_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

phone1

string

optional

Phone number.

Example:

string

phone2

string

optional

Phone number.

Example:

string

phone3

string

optional

Phone number.

Example:

string

phone4

string

optional

Phone number.

Example:

string

phone5

string

optional

Phone number.

Example:

string

picture_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

position

string

optional

Simple text input field.

Example:

string

quick_account_name

string

optional

Simple text input field.

Example:

string

share_mode

enum<integer>

optional

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

Allowed values:

0123

Example:

state_province

string

optional

Simple text input field.

Example:

string

title

string

optional

Simple text input field.

Example:

string

unit_id

string <uuid>

optional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

zip_code

string

optional

Simple text input field.

Example:

string

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

formatted_name

string

required

Example:

string

social_media

string <uri>

optional

Relation to ContactSocialRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ContactSocialRelation' 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.

account_relations

array[string <uri>]

optional

Relations to Accounts.

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.

exchange_entity_id

string

optional

Example:

string

gapi_entity_id

string

optional

Example:

string

o365_entity_id

string

optional

Example:

string

is_favorite

boolean

required

Example:

false

primary_account_account_roles

array[string <uri>]

optional

Roles of Contact in his primary Account.

primary_account_position

string

optional

Job position of Contact in his primary Account.

Example:

string

account_position

string

optional

Job position of Contact in his primary Account or quick account position if Contact has no primary Account.

Example:

string

is_unsubscribed

boolean

optional

If account has any unsubscribed email.

Example:

false

tags

array[string <uri>]

optional

Relations to Tags.

static_profiles

array[string <uri>]

optional

Relations to Profiles.

primary_account_relationship

string

optional

Org chart relationship of Contact in his primary Account.

Example:

string

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",
      "contact_type": "http://example.com",
      "currency_exchange_rates_list": "http://example.com",
      "owner": "http://example.com",
      "picture": "http://example.com",
      "unit": "http://example.com",
      "address": "string",
      "city": "string",
      "comments": "string",
      "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "country": "string",
      "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
      "email1": "string",
      "email2": "string",
      "email3": "string",
      "email4": "string",
      "email5": "string",
      "first_name": "string",
      "gender": 0,
      "is_archived": false,
      "last_name": "string",
      "middle_name": "string",
      "owner_id": "01234567-abcd-dcba-ffff-000000000000",
      "phone1": "string",
      "phone2": "string",
      "phone3": "string",
      "phone4": "string",
      "phone5": "string",
      "picture_id": "01234567-abcd-dcba-ffff-000000000000",
      "position": "string",
      "quick_account_name": "string",
      "share_mode": 0,
      "state_province": "string",
      "title": "string",
      "unit_id": "01234567-abcd-dcba-ffff-000000000000",
      "zip_code": "string",
      "revision": 1,
      "formatted_name": "string",
      "social_media": "http://example.com",
      "primary_account": "http://example.com",
      "account_relations": [
        "http://example.com"
      ],
      "sharing_units": [
        "http://example.com"
      ],
      "sharing_clients": [
        "http://example.com"
      ],
      "documents": [
        "http://example.com"
      ],
      "exchange_entity_id": "string",
      "gapi_entity_id": "string",
      "o365_entity_id": "string",
      "is_favorite": false,
      "primary_account_account_roles": [
        "http://example.com"
      ],
      "primary_account_position": "string",
      "account_position": "string",
      "is_unsubscribed": false,
      "tags": [
        "http://example.com"
      ],
      "static_profiles": [
        "http://example.com"
      ],
      "primary_account_relationship": "string",
      "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