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": "99492949-b6b3-480e-9516-49b171df123e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1fd916e8-a5e1-469f-a87d-992230c4af6e",
"company_code": "sample string 5",
"company": {
"id": "40a84af0-b80b-40db-ac48-5211d11a376b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-03T20:49:11.5379256+00:00",
"sales_territory_id": "7ea8ff61-7c9a-41d4-b6e0-a9511d77aa6e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "553fd17d-ca1c-4de9-bee1-a1d84bda99ce",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cb7bbd63-b5c8-4d6b-b5ac-04f8c8e4b3f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8c7f259-6cb0-4df5-b5b8-65310157d58d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "61a0c7df-19ef-48da-93e5-ddf5c81b3990",
"db_currency_id": "213436e8-6595-45f6-87b8-25c98ebe0177",
"db_language_id": "228aa0d2-4753-49f5-99d0-19c1c6352801",
"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-03T20:49:11.5379256+00:00"
},
"modified_dateutc": "2026-09-03T20:49:11.5379256+00:00"
},
"marketing_segment_id": "4afc2b84-9b0d-41d4-935d-ea5c0873d302",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "62422079-c3f4-40f6-8273-f1db0c9340ca",
"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": "09dede32-6ba0-4553-b86d-88026a924502",
"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": "5f12c4ac-7c3d-4d5c-8b1d-24ff151fcb3f",
"db_country_code": "sample string 28",
"feelist_id": "8ade3991-cafa-4efa-95cd-dc427d1f824b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1d92df0b-7db0-46c2-ae47-c90d56308efb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7f16ae72-c5b5-4ddf-add1-ca31b291aca8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-03T20:49:11.5379256+00:00",
"db_currency_id": "d29dc82d-7024-4e5f-991d-095a0b733533",
"db_currency_code": "sample string 10"
},
"company_type_id": "49c299ed-3226-4a3c-8e07-b028ccd3296f",
"company_type_name": "sample string 32",
"company_type": {
"id": "cb125504-9df8-4067-965c-bfb28fbf02db",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "84de7114-00f7-443a-b6dd-982966f0aa4b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "61b52e9f-ccf3-47ff-88d6-46b73a9a8a81",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "dd82df20-da69-4700-9741-aba5e8131ace",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6ad6c478-94a5-4615-be0b-ceb5ebed76ae",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "17dfc8e6-b30e-48da-b99c-1a8099b5088d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-03T20:49:11.5379256+00:00"
},
"company_sector_id": "7d3f8908-f874-44ea-b526-60a514620749",
"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": "0928e655-6fd7-483e-83d5-f3af18565d85",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "89c87172-65d8-40f6-ba52-0e01a97ea743",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8289b7b7-429c-474f-8a38-11f124f3e820",
"account_manager_user_code": "sample string 56",
"company_status_id": "f679fd26-3366-4463-8f16-5929ad2a3869",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-03T20:49:11.5379256+00:00",
"id2": 60
},
"db_language_id": "f074e12c-0c3f-4e39-a506-fc689168edc7",
"db_language_code": "sample string 7",
"db_title_id": "96dc8b56-3fb4-47d0-9fe4-fed5842f5a77",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-03T20:49:11.5379256+00:00",
"create_date": "2026-09-03T20:49:11.5379256+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-03T20:49:11.5379256+00:00"
}