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": "cc0ef9bb-4279-4bfe-91bc-740e6a9f55f5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "61aff3c2-9c41-42ce-a683-fac2b7cf3876",
"company_code": "sample string 5",
"company": {
"id": "83c60a19-a3f0-41b8-a178-b35bf608e0c5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-10T16:38:39.3284748+00:00",
"sales_territory_id": "c377a39c-2a16-4495-889c-4405de372c93",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c5b6874a-9d3c-4dae-8074-38107ef03825",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "924483d9-9622-470e-982c-b6a4d443ef79",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4cf1add-1f62-45f1-808d-0dff53769a5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8d84729f-df62-44c3-9213-f6f08677a0b8",
"db_currency_id": "a183271c-b9fc-44e0-a2fc-cf8dc0133e39",
"db_language_id": "2f95cfda-bd8a-404d-ae91-283c79cb78f6",
"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-08-10T16:38:39.3284748+00:00"
},
"modified_dateutc": "2026-08-10T16:38:39.3284748+00:00"
},
"marketing_segment_id": "7196c6ff-45a4-4660-a9c6-a2844bbe545f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "225b15c9-9cbd-4f39-96ab-a7bf4e9dc1d4",
"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": "e3a04090-f011-4242-b746-0be98f213520",
"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": "792920c7-9a5d-48c9-80aa-2643870f09c4",
"db_country_code": "sample string 28",
"feelist_id": "de1aeaa3-d6f9-4906-8a62-b8ac3fbc377e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c7eb4f92-4c45-4737-bc06-1f671fe65305",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "28c5cc9b-10a8-44bc-a8c9-823745f14bbb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-10T16:38:39.3284748+00:00",
"db_currency_id": "38ced82c-e204-4ebb-a1f1-a6c7577148e2",
"db_currency_code": "sample string 10"
},
"company_type_id": "a9a39432-4ec8-46d0-ab8a-29ee565ebfa8",
"company_type_name": "sample string 32",
"company_type": {
"id": "dbe66e9b-5f57-4502-84d8-234080ea98f5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0022aee6-419f-47ca-a013-8a0a056547e1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "c0eea0d0-70ac-47f6-9b6d-643679199056",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9c43854e-7e5c-485d-a37d-e3a0d321f258",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0248e4fa-7f2b-4f5f-90a0-e6525b6784a8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a6f4a59d-773c-484d-a512-55c55579b4b0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-10T16:38:39.3284748+00:00"
},
"company_sector_id": "fc70bd00-e3f8-4031-928e-30205903fb4b",
"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": "88eb33a8-51c1-43b7-b3fe-86766477856e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b4c26e03-9d30-4f89-92e0-61186ea83b27",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "707bc053-492e-4bef-bf2d-e9b3428d0a6c",
"account_manager_user_code": "sample string 56",
"company_status_id": "410d7632-535e-469c-9e4e-a7396cd72b1a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-10T16:38:39.3284748+00:00",
"id2": 60
},
"db_language_id": "27523aee-1cef-4397-b77c-96d0e157da7a",
"db_language_code": "sample string 7",
"db_title_id": "363503d2-0b17-4d0c-add8-ddc3ead29d3d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-10T16:38:39.3284748+00:00",
"create_date": "2026-08-10T16:38:39.3284748+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-08-10T16:38:39.3284748+00:00"
}