Retrieves all the company contact
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": "ad911e24-9274-414a-b271-5fbb70b5d600",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "54f80c33-3f16-4709-b2ff-b93dd557c190",
"company_code": "sample string 5",
"company": {
"id": "8e4b9536-e821-48c2-8c1c-334dfd859353",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-08T05:55:02.8037901+00:00",
"sales_territory_id": "2223f574-71a4-4ab0-868f-c4061a8eebe8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "51040f26-8137-4d60-a907-07c2fe8632ba",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "80c58345-3a1c-4fa2-887c-e54b01ac90b8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d9bc9eea-101b-4644-ba44-248d0e8dcf59",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "625fbd5d-ae2a-4d72-bab0-8f73fbb68af8",
"db_currency_id": "5a2b5751-8418-45d1-9a8e-d6169d266e03",
"db_language_id": "1be62171-2682-41a5-998b-17efa49cb9f4",
"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": "2025-10-08T05:55:02.8037901+00:00"
},
"modified_dateutc": "2025-10-08T05:55:02.8037901+00:00"
},
"marketing_segment_id": "0bfb9517-e437-433d-9041-43af40c2203f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "db1e5a15-3904-4065-9838-1514fb1f191e",
"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": "ee8b2680-cffc-43c6-98cf-cd8636da32b3",
"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": "1ca394b9-3ec4-4efc-ab8f-4c0ef7105987",
"db_country_code": "sample string 28",
"feelist_id": "9514c9a2-3adf-43d5-8639-2dd9cbb12c8a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "100ba82d-0687-43fe-8283-4f6ab983dc0c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "64e528f3-5a31-4ccd-b68b-0455bb9391c3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-08T05:55:02.8037901+00:00",
"db_currency_id": "e341d25b-3abb-4d4a-9470-96a6f667729b",
"db_currency_code": "sample string 10"
},
"company_type_id": "50f09399-32a4-4b8b-9038-8fd08123d8c6",
"company_type_name": "sample string 32",
"company_type": {
"id": "2282153a-57f6-408f-b61d-fbfdcf1f962d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "765720c1-0457-41ad-8971-2043e63008b9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "071388fa-20a8-42ca-b214-f29303c9c181",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "68e48d2e-5185-4642-83c9-8518c6052879",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dac9b9d6-87a0-4992-b31b-67237e9265b7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6000a5fe-ef95-4529-bee4-789b5b1cfc36",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-08T05:55:02.8037901+00:00"
},
"company_sector_id": "a0a2eb95-d358-472a-bbf8-8fc3bd7f9b8e",
"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": "dcb4507e-5d0d-4757-b0de-8030e025dd24",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fb71385a-0b0b-4701-a443-0b7804e2f3f1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fa841da1-7fe0-4984-8a27-4f6c8e7351d5",
"account_manager_user_code": "sample string 56",
"company_status_id": "9ded7af6-1fa8-4fb5-bdd0-a4e7ff53cac1",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-08T05:55:02.8037901+00:00",
"id2": 60
},
"db_language_id": "4f55f043-720d-4d29-8ce1-0b513c825d37",
"db_language_code": "sample string 7",
"db_title_id": "94c00656-e804-4305-a8bd-6e2fd061bb34",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-08T05:55:02.8037901+00:00",
"create_date": "2025-10-08T05:55:02.8037901+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": "2025-10-08T05:55:02.8037901+00:00"
}