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": "276331cb-9c54-4202-b808-71428e236695",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e50cac88-ff33-4e4b-82b6-1a3d51b58a83",
"company_code": "sample string 5",
"company": {
"id": "1bfa351f-5f72-4feb-9830-4c7891377da9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-10-06T14:56:29.0491952+00:00",
"sales_territory_id": "3201c2e0-4cc8-442c-89ba-94984d1970da",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f7d987da-7153-4f15-8e77-42f7a14982f2",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "86259c6a-6db2-46d1-8800-76bd95e854f1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2f54d388-7f56-4ea9-b39d-3e6689f93a95",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "406b72c7-948f-49d0-9e6f-ac01913ff9a3",
"db_currency_id": "81d99033-1550-4fb5-b04f-ab0f1c2c22de",
"db_language_id": "59dded0d-a7da-46a2-8167-9ea8a04a990c",
"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-10-06T14:56:29.0491952+00:00"
},
"modified_dateutc": "2026-10-06T14:56:29.0491952+00:00"
},
"marketing_segment_id": "3aac3d48-d47c-4503-990b-41344d874b36",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bf72d164-7948-481a-b4cd-b02a169fef50",
"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": "a476114e-5899-42d6-968c-513f605bd21f",
"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": "e15ebef5-bf44-43d9-8cc2-24db61b45300",
"db_country_code": "sample string 28",
"feelist_id": "e8f93b3a-f0b4-4a93-af24-5ba48cf7a9bf",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7844a57d-9967-4b90-9de4-4956f717839e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5165ecd4-3d52-4a61-a6b3-e0474717aed9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-10-06T14:56:29.0491952+00:00",
"db_currency_id": "66116870-2e2b-4bbe-9300-ee1fa176a680",
"db_currency_code": "sample string 10"
},
"company_type_id": "6bb2ed39-e215-491f-bfae-5e6d929ec994",
"company_type_name": "sample string 32",
"company_type": {
"id": "394d531e-df4a-4ddb-8551-6b31ddf24ab7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "907e4171-1bd3-4de8-8ae2-452ef6094d2a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7e1dd164-5a0c-4bf3-a64f-eea5f19c2ba9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4a751a97-654b-4b83-9313-f49fb520f26b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b0891e79-5909-4173-b441-be9297024bb1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2a25f77e-a65e-45bb-8c75-9ec1717092c8",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-10-06T14:56:29.0491952+00:00"
},
"company_sector_id": "f4b1dc11-f1cb-48e0-8cb7-bb61e8cb632f",
"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": "ae1860b2-37c9-4d5f-ba61-772c2abd3670",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f6ac86f7-21b4-4ca9-87b2-1c9ef5090d0d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7726b603-0521-4615-a5ea-97b6c825329a",
"account_manager_user_code": "sample string 56",
"company_status_id": "2e9c285a-4bd5-4b73-8134-5ad3f79df2d6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-10-06T14:56:29.0491952+00:00",
"id2": 60
},
"db_language_id": "684291e1-65dd-4b6a-864c-8b9d1cc508c1",
"db_language_code": "sample string 7",
"db_title_id": "de745f64-b8f0-40de-8f87-6f7ad30cf1ee",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-10-06T14:56:29.0491952+00:00",
"create_date": "2026-10-06T14:56:29.0491952+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-10-06T14:56:29.0491952+00:00"
}