Function /contact/list
Function invocation
https://json.aftermarket.pl/contact/list
Function description
Returns the list of user contact profiles.
Input parameters
This function takes the following input parameters:
| Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
| size | integer | 5000 | Paging: number of list elements | |
| start | integer | 0 | Paging: starting list element | |
| integer | 0 | Paging: page number (deprecated, please use 'start' parameter) | ||
| integer | 5000 | Paging: number of list elements (deprecated, please use 'size' parameter) | ||
| integer | 0 | Show only visible profiles (0 - show all, 1 - show only visible, 2 - show only hidden) (deprecated, please use 'hidden' parameter) | ||
| hidden | integer | 0 | Show only hidden profiles (0 - show all, 1 - show only hidden, 2 - show only visible) |
Return value
List of contact profiles (list of structures with the following fields):
| Field name | Type | Description |
|---|---|---|
| address | string | Address |
| string | Additional address part (deprecated and unused) | |
| city | string | City |
| string | Company name (deprecated, this value is given in 'name' field) | |
| contactId | integer | Contact profile id |
| country | string | Country |
| default | boolean | Default profile |
| string | Contact profile email address | |
| eu | boolean | Contact country placed in European Union |
| string | Fax number (deprecated and unused) | |
| hidden | boolean | Contact is set as hidden |
| string | First name (deprecated, this value is given in 'name' field) | |
| linkedDomains | integer | Domains count linked to profile |
| name | string | Contact name |
| string | Last name (deprecated, this value is given in 'name' field) | |
| memberId | integer | User id |
| person | boolean | Contact represents private person |
| phone | string | Phone number |
| profileName | string | Profile name |
| zip | string | ZIP - Postal code |