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": "cd0a6b7e-550c-4c1f-9d69-ce277da7c524",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3a3f5006-229f-4fd0-9cf2-c812be287153",
"company_code": "sample string 5",
"company": {
"id": "7d7c6a53-5a6a-4acd-b736-de5482c91005",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-16T06:17:49.2604566+00:00",
"sales_territory_id": "7ab443a3-36e5-4bb5-8cf3-8024b7a20a67",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d7d8e363-7bed-4bb8-9f8e-ae35d8adfad5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aeb923ce-8fa5-45c1-9fcf-5de6a6ab8264",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d28c80b6-f1ef-4bbe-9f09-ccd93e7d6e87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92fd4bc4-4f46-46cc-8a08-40b2789af2c0",
"db_currency_id": "280e0d87-011f-46fd-b706-3ea4fb4f1744",
"db_language_id": "7771a4c0-8a7a-47b8-b1de-429e2a32aba1",
"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-16T06:17:49.2604566+00:00"
},
"modified_dateutc": "2026-09-16T06:17:49.2604566+00:00"
},
"marketing_segment_id": "07da027e-18f6-4a38-aec7-de6fde1cb0f8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b83a2c9c-c583-41c6-b8a4-8e9f6145fb19",
"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": "c78699ac-1bed-416f-9b2a-96ab0dfd20c7",
"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": "202d90b1-b2f8-4068-9fa9-7035ddb92a7a",
"db_country_code": "sample string 28",
"feelist_id": "79c9ede1-8c11-4784-aa50-d4a222a31a84",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2de84185-1693-4a0c-ac78-0a305b4f89a6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d13337db-390e-4120-9a78-05e90fb50532",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-16T06:17:49.2604566+00:00",
"db_currency_id": "ae5734d0-ec7b-4f63-9341-3032bb25ad96",
"db_currency_code": "sample string 10"
},
"company_type_id": "197c9105-5bd9-471e-a89c-ed9f61d501cc",
"company_type_name": "sample string 32",
"company_type": {
"id": "795680de-c31b-4b16-b89a-daaa21f5f50c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1d9c4d59-7e9c-4648-a16b-5d9761528585",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3f569839-275d-4b6b-a153-3c984d42bc1d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "802b48b6-3bf8-4b1d-be58-8b863b29e92e",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6f929509-8aa6-4448-be71-0742cec64a1c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c53352f4-988a-4f6e-9e4b-0310f91e748a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-16T06:17:49.2604566+00:00"
},
"company_sector_id": "e5ce9439-66d3-438e-a1a8-d0a799e1f513",
"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": "6f58ddd0-60d3-4033-b29e-4eacf29b88cb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "495da692-a7f7-4749-8b7a-db13cdd2fd0f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "228cd478-1c5a-4f36-8abf-75cde5298279",
"account_manager_user_code": "sample string 56",
"company_status_id": "18fa8508-8c5d-4282-8575-c505232a8b33",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-16T06:17:49.2604566+00:00",
"id2": 60
},
"db_language_id": "4c4a1e40-039e-4e4b-81c0-465560a4ef4b",
"db_language_code": "sample string 7",
"db_title_id": "abc83fb1-9c09-4740-9bfb-576114157d18",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-16T06:17:49.2760786+00:00",
"create_date": "2026-09-16T06:17:49.2760786+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-16T06:17:49.2760786+00:00"
}