Retrieves all the contacts
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "25d5e7a1-81b5-45cd-89bd-34b8266da611",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "07ad4445-fbcc-4475-8f74-c5a9f1fb0ed9",
"company_code": "sample string 5",
"company": {
"id": "85cd80b5-c69a-45a3-9d70-2b6dfe1af769",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-14T15:17:14.471852+00:00",
"sales_territory_id": "32d7f723-cfb2-4c59-ab56-346be3f32158",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eaceeb44-f5fd-40ea-861a-2c5dd54595ae",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a87608e1-b749-4285-acea-493f505dd43e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df5b87ea-c5a7-47a0-b3cf-d2bd7a2556f6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "199f44e2-1aab-4d9b-a1c9-f6d696b078e8",
"db_currency_id": "6bf0954f-4bd8-4f02-8f44-886c5a5bb499",
"db_language_id": "e48be510-5022-4ae6-8ead-8c234fc3cd60",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-06-14T15:17:14.471852+00:00"
},
"modified_dateutc": "2026-06-14T15:17:14.471852+00:00"
},
"marketing_segment_id": "8d5fa3d2-2383-4dcc-8e54-6ca8195f1b44",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "30ce9cfa-9943-4f27-8ae9-81f8faaf3a78",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "a6c6c2e8-d872-4e4f-be28-acc998be768b",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "752a6d7b-d688-49a9-a2c8-dda054bd74cc",
"db_country_code": "sample string 28",
"feelist_id": "fbcb6453-f98b-443a-ab4c-ae132577f858",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "509a86ca-01f8-4800-8365-14ed197ef9b9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a4c363c9-5526-4716-9c6f-155b1262e75e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-14T15:17:14.471852+00:00",
"db_currency_id": "cf0879aa-290a-4c70-88ec-af0d281300fe",
"db_currency_code": "sample string 10"
},
"company_type_id": "0f0623e7-2a1e-48b2-bc5e-254e036e4293",
"company_type_name": "sample string 32",
"company_type": {
"id": "df8f40f6-3d3a-4399-963f-85d6bc0a03de",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f003873-5263-49e2-9eab-cb068464d70b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ebabab33-6626-4c8b-858f-05863e194e97",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "34105dc8-4896-460e-9baa-128c91d65bd7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a5a5992e-2286-433f-9a53-cb33d0eefc08",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "26365fb9-221c-489f-943f-4c5ea63c4e10",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-14T15:17:14.471852+00:00"
},
"company_sector_id": "8054fb95-5f13-4722-9a34-1d0bd75c0b32",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "4cf57cb3-b4e9-4490-950d-a95c0fc41848",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "694a8230-3795-4c9e-8899-1b84acc12834",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "96575a31-9677-4b0d-8d92-6cfe9e4eb736",
"account_manager_user_code": "sample string 56",
"company_status_id": "12dd0140-441f-47df-b7a0-97c727db47e8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-14T15:17:14.471852+00:00",
"id2": 60
},
"db_language_id": "fbfd8b84-9711-4377-a331-65663d6e8212",
"db_language_code": "sample string 7",
"db_title_id": "5fcb904e-641c-49d6-ba04-67f4a3ae1873",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-14T15:17:14.471852+00:00",
"create_date": "2026-06-14T15:17:14.471852+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2026-06-14T15:17:14.471852+00:00"
}