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": "a6757794-e356-4210-8ba1-892f463301da",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a017a1f4-6a35-4d61-9b9e-f8c711a891fe",
"company_code": "sample string 5",
"company": {
"id": "793980aa-b439-4eb4-990a-ff8cafee1d35",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-09T22:25:34.0873495+00:00",
"sales_territory_id": "2d3752e2-9353-4fd3-86e7-eda518c33e0e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bdcc06b7-4fdb-4a90-962e-06e090e76960",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bef33680-b867-42c4-ba89-4ff8231beb4a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb46e8ec-d5f0-45d3-ab2a-906afd3ee0a4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0488cd40-4ce8-4dfb-8687-82da95f94340",
"db_currency_id": "03db1a31-3147-4318-a9dc-d5395afb17f5",
"db_language_id": "888a67e9-12fe-4a73-9361-c7bd268b7c42",
"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-09-09T22:25:34.0873495+00:00"
},
"modified_dateutc": "2026-09-09T22:25:34.0873495+00:00"
},
"marketing_segment_id": "5105c219-8273-4b23-9c4b-755bf27aaf78",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b38a0b67-1338-40a3-bb6f-e5b7c6c3fc6d",
"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": "534d4ff4-2a2e-40b0-b5c2-a2af432a1dc2",
"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": "9b37596f-1ff2-40c6-a902-ac2e98533c03",
"db_country_code": "sample string 28",
"feelist_id": "fdb625f1-2947-4f90-95f3-7b80f9724efb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9986678c-640b-4a3e-bc26-bb453a847a68",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "524e518b-c71e-414d-ac82-2b7805ad6b1d",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-09T22:25:34.0873495+00:00",
"db_currency_id": "4b2afdf1-df9f-4045-aa57-ecc751bc20d8",
"db_currency_code": "sample string 10"
},
"company_type_id": "1ce56b77-67b8-422a-b3cb-090b419d6342",
"company_type_name": "sample string 32",
"company_type": {
"id": "e34acbd9-8fab-4d3f-957c-6250191bea28",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2e9ebd1b-b26e-4064-a9f4-b74c5e5dc590",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3af7559a-7138-49cd-ac56-d8677483534e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ae4bc7b7-ea70-4b0e-817d-1b6828635f51",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f1db4e6f-ca68-4732-a637-15f56d624e80",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fe251a2f-7eb8-431b-a9f9-ea452a1320ca",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-09T22:25:34.0873495+00:00"
},
"company_sector_id": "cc6cf63d-e285-4da0-a04f-00a144941eb5",
"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": "346c55b2-700a-433c-b5fc-92a3c738da23",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8298d7da-cb98-425e-bd4b-2ce553d82522",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "91eebc92-199f-4990-9f67-bca06d129713",
"account_manager_user_code": "sample string 56",
"company_status_id": "6419048e-a2aa-44ee-8f53-e95439b71098",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-09T22:25:34.0873495+00:00",
"id2": 60
},
"db_language_id": "c82a12e9-d561-4e39-b34e-db9b9b8f961b",
"db_language_code": "sample string 7",
"db_title_id": "4dd54298-84ad-4887-8dd7-7243d0acaaac",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-09T22:25:34.0873495+00:00",
"create_date": "2026-09-09T22:25:34.0873495+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-09-09T22:25:34.0873495+00:00"
}