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": "aafea682-cb4d-4b2d-a5ba-387a0be8ffac",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "049b0fec-8192-468f-a4fe-de585a7896b5",
"company_code": "sample string 5",
"company": {
"id": "339f96f2-847b-416c-880c-59d5af3f0fe3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-12T14:58:02.230174+00:00",
"sales_territory_id": "22f6f7d2-4f07-409e-b0f7-76ec5d0f5efc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bb68b98b-d22a-4e30-a7b0-25f27bf30504",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5d69128-755d-4517-a736-3bce0f9d1913",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "516a30d7-d0aa-4310-a05d-63cc8832e9f3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afda3bdf-22f2-4d8e-80e3-3004725ca026",
"db_currency_id": "635b2b01-5e95-4a6f-9401-e7333d9360c4",
"db_language_id": "a7e3f761-edf4-42c3-8e46-889ba3c13fdf",
"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-07-12T14:58:02.230174+00:00"
},
"modified_dateutc": "2026-07-12T14:58:02.230174+00:00"
},
"marketing_segment_id": "7a2b8cc6-06e8-4af5-bdc1-b1de9946379a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "32387b0e-76b1-4d3e-bd8e-8324677b6777",
"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": "fd8fb526-27c2-4e72-8e11-7b358fc7cdbc",
"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": "1ea1502b-985c-4a9c-b495-d3aae8341e51",
"db_country_code": "sample string 28",
"feelist_id": "856b0059-ad9c-4877-8970-fe1fe7c5e903",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bcc7ba86-e7c8-449b-b591-5964c85cde80",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9c166d00-dc47-49d0-ae8e-4b584603b406",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-12T14:58:02.230174+00:00",
"db_currency_id": "7058644e-65ab-401a-b32c-f5dbabadd956",
"db_currency_code": "sample string 10"
},
"company_type_id": "fb1b87d8-2864-45e2-8327-ea7e071f65eb",
"company_type_name": "sample string 32",
"company_type": {
"id": "3c757635-3976-496b-b0e3-f8374966896c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "db5d3bb0-8555-44d6-bb1d-038619f8859b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d914ac6f-a0ed-4a07-891f-ddbf85fa3092",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7715093d-5ed7-4e97-bcad-00254e98388f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8e2c61cd-ad0f-47e3-b829-1bf4760916bc",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "89c96a25-d71d-484b-9742-2210c9440d5d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-12T14:58:02.230174+00:00"
},
"company_sector_id": "5c4ed401-4b48-4d49-a660-e0c10dd72e97",
"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": "da2be90a-1917-4df6-850f-6153c9267462",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "75f87019-6bdb-4901-b640-756baf1d47de",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2f085d0d-65e8-4d74-a3a5-a2ba847937f1",
"account_manager_user_code": "sample string 56",
"company_status_id": "bff37fc5-d9c8-435c-9123-ff8951c41ce2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-12T14:58:02.230174+00:00",
"id2": 60
},
"db_language_id": "2475657c-b067-42bb-8630-4152ce403c5e",
"db_language_code": "sample string 7",
"db_title_id": "43129190-0068-4044-b909-914040a0d650",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-12T14:58:02.230174+00:00",
"create_date": "2026-07-12T14:58:02.230174+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-07-12T14:58:02.230174+00:00"
}