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": "5426a62f-6ab3-4d9c-80db-d5fc4ab3d7ef",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c21b3bac-4bf8-476d-a0c6-d0b4c18e7c0c",
"company_code": "sample string 5",
"company": {
"id": "21e86edf-1be5-46f3-943d-6a26b38221db",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-25T22:00:30.4749587+00:00",
"sales_territory_id": "b08d8966-6a1f-45bc-be5d-46dbb8e53281",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "392b1ec7-bec3-46d1-90e9-6a935109b824",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e3961e8e-da4e-497d-b726-4a2e42abd650",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ce111b85-87fd-4027-b8ad-88686a6fd352",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2867d3b2-edee-4e50-b4ad-a7969e834f02",
"db_currency_id": "c33570e3-545a-4b02-9206-b8cfa6355481",
"db_language_id": "f0aaf8e3-dafb-40b0-a21b-e61047e0dedf",
"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-02-25T22:00:30.4905827+00:00"
},
"modified_dateutc": "2026-02-25T22:00:30.4905827+00:00"
},
"marketing_segment_id": "26c983a7-9683-488f-a64c-1b37004b53cf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "025ccbe2-d82a-40a4-9e63-a27cf6e4c8c6",
"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": "a8e2273c-5e42-4fc6-b9ec-ce3a32233029",
"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": "f26a1b54-41f8-444e-8403-3b3517ea991b",
"db_country_code": "sample string 28",
"feelist_id": "7e9b045e-f127-4804-920f-e9d76ffa6fde",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b0f061c3-7fd3-4549-b421-f13ed067d035",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1f640df6-98dd-485c-9ff9-71f34a416b83",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-25T22:00:30.4905827+00:00",
"db_currency_id": "2f1add05-85d0-4644-ba77-ae9c309f7385",
"db_currency_code": "sample string 10"
},
"company_type_id": "bfc23167-ee81-46c1-bb66-7899519dee19",
"company_type_name": "sample string 32",
"company_type": {
"id": "cb46b027-a6b6-49ff-abae-e4d6123b193c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c23933d2-ac64-4dae-9cd5-2df068b3b04d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bcf7c38d-0be4-4f07-993d-542fd0248d93",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "06a3e091-3078-4169-8cdc-84b2c085dc80",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d4a046e8-3f78-4f12-b363-804c3c901394",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6ad80ced-f076-427d-90e5-4b6ee61acb05",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-25T22:00:30.4905827+00:00"
},
"company_sector_id": "ea709b1c-8dd3-4f7e-9486-13bdf2e96cf5",
"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": "0d8105a0-8d9b-43ea-8dc0-be411a0916cd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a4d2a08c-2112-40ad-8957-e2f352333607",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bcc49a85-9199-43bc-b700-8970a7abff00",
"account_manager_user_code": "sample string 56",
"company_status_id": "e65d98b6-3564-40ea-956b-4e32a96a2057",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-25T22:00:30.4905827+00:00",
"id2": 60
},
"db_language_id": "3dcf1853-206d-40ce-bafd-1de47d7586f0",
"db_language_code": "sample string 7",
"db_title_id": "ec6261e2-216d-456f-af92-350836c3ece1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-25T22:00:30.4905827+00:00",
"create_date": "2026-02-25T22:00:30.4905827+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-02-25T22:00:30.4905827+00:00"
}