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": "21b95cc6-d423-4aaf-b20f-ff48bdb850ac",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4d117d99-f94d-4b7c-8a40-8345b9d4c5dd",
"company_code": "sample string 5",
"company": {
"id": "fb2ac588-2bd5-4346-9d37-7e94b7f163da",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-10T02:17:14.7810905+00:00",
"sales_territory_id": "52d6bb1d-c19d-4599-809f-7dbcd9cbaae4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7af0ccd7-b2f7-4b0f-a81f-a249b04511b3",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ad8bf166-14b8-46a3-9376-e83644a1cc0d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40833895-232e-4eb6-8ea6-008e04bd05b3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89725f4d-0049-4551-9737-0450830d6913",
"db_currency_id": "de293f20-ff3a-4eb4-8faa-7bbe0f59cfe2",
"db_language_id": "88141e7f-c884-43eb-95c1-cbef16308d5f",
"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-04-10T02:17:14.7810905+00:00"
},
"modified_dateutc": "2026-04-10T02:17:14.7810905+00:00"
},
"marketing_segment_id": "9007cd72-7701-49cf-a05f-0ab38d02a8cc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "90591267-d4fd-46fa-a898-e60b5cbca3b4",
"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": "5e666b34-ff50-4508-8b85-3957f0d87b5f",
"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": "944c10fd-cb43-4d07-9961-121ad293ff5b",
"db_country_code": "sample string 28",
"feelist_id": "662fc6d2-d75a-45ef-8933-1e0ab3419014",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "361d11b0-8c3a-4b84-bd33-0105d4deaad6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "122c9542-63d9-4753-97fa-7776a5551afd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-10T02:17:14.7810905+00:00",
"db_currency_id": "1f4e4e85-9ee5-4fa9-b9a3-82aee17e0669",
"db_currency_code": "sample string 10"
},
"company_type_id": "eb7dba08-0c7f-4660-949d-463c7274305f",
"company_type_name": "sample string 32",
"company_type": {
"id": "a9914f0d-d14a-483e-a6d3-c97e7284e554",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c92af824-cc36-4228-8e57-062bf95a6a2e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2ce8fd58-202b-4c13-9ecc-fe3996ba017d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "eba7911a-7e9e-4e03-b62d-fd754c0873c0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2f103d4d-42b6-479b-a57e-cdec494a825d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "95a4a7b5-bd84-4bd9-9686-05ff4a4b1def",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-10T02:17:14.7810905+00:00"
},
"company_sector_id": "d61adbc1-98d1-4781-81bd-7786ddaaf48b",
"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": "195aecb8-6b51-4146-b850-af88cccd3a43",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8e214851-bba0-4177-96cf-14c1f0d1b60c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d006ad86-f100-446d-a0b2-846fbf2a03b2",
"account_manager_user_code": "sample string 56",
"company_status_id": "3324d8a6-a113-44ae-94fd-7f91219dacee",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-10T02:17:14.7810905+00:00",
"id2": 60
},
"db_language_id": "18504c3f-b3c9-4fa6-8fbc-a3f6eeb59b2a",
"db_language_code": "sample string 7",
"db_title_id": "bb961fb5-9c5e-474d-843d-cb7968dc9f1a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-10T02:17:14.7810905+00:00",
"create_date": "2026-04-10T02:17:14.7810905+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-04-10T02:17:14.7810905+00:00"
}