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": "c5454414-4f23-4a3b-9af4-ceef10ddf4a5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f5e13e89-d15f-410a-a9ec-4ecb003919bb",
"company_code": "sample string 5",
"company": {
"id": "fa186f84-92f3-49f4-969e-929811a0f1d8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-16T05:10:12.3076059+00:00",
"sales_territory_id": "ded471f3-3048-4dd8-b658-6c226971dfac",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "fd81f174-8697-4c5a-b078-a453e34eab39",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7036e4b0-24f6-43bc-ad28-ef599e2caac0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "02cbdfd9-9b51-4a11-9c01-5192c51c2d6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c043161b-023b-4950-a61a-cb53764e4e7f",
"db_currency_id": "754d0d77-bd47-4745-bb16-dfac2fbefce1",
"db_language_id": "99a49ab0-c1de-47aa-b3f9-631d5d5064ce",
"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-16T05:10:12.3076059+00:00"
},
"modified_dateutc": "2026-02-16T05:10:12.3076059+00:00"
},
"marketing_segment_id": "977f9177-5cc0-40fb-90b2-56c0dd9f864c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "bf7e0fd3-313f-422a-85a0-74a6c2d8465c",
"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": "61d7e920-8341-4e43-af8d-e72d16835cf8",
"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": "b3aed289-73de-4419-8e94-5ce9e9677520",
"db_country_code": "sample string 28",
"feelist_id": "c67a61ef-fd0f-4655-9c90-02cd3910f424",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f91e58d6-c584-4660-bf2f-0c0b2fd33070",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bcc0dd89-40d5-4cb9-bbe1-a6f7506a0625",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-16T05:10:12.3076059+00:00",
"db_currency_id": "c8b17e5e-8440-487b-86d1-8fe519d4f3cb",
"db_currency_code": "sample string 10"
},
"company_type_id": "9410b17b-9b4b-4378-a15a-1332d64cdccd",
"company_type_name": "sample string 32",
"company_type": {
"id": "deba934f-3baf-43b0-a044-5e5ae8a896a5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9edf9ccf-76ec-4c8d-9921-e1212324aef9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "36d3c25a-603c-4ec3-91ca-fb014989a0e5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6867807f-0bd3-4456-9c7b-485283f0b854",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5c5c9375-0f5b-4b66-aac1-3de109634f89",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b9cf0ddc-c5cf-4600-b814-77628817a15c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-16T05:10:12.3076059+00:00"
},
"company_sector_id": "7d09a4db-9ddb-4e37-824a-377fc41ef722",
"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": "4f6520af-bdf8-4977-8bf0-ef39a2065c00",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "89164dd8-5430-425f-bf54-7d64dc44dfa8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3052a848-e211-4230-9a9b-6c34b4a5ea13",
"account_manager_user_code": "sample string 56",
"company_status_id": "64817d78-679b-4e65-b089-39f0d4792988",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-16T05:10:12.3232006+00:00",
"id2": 60
},
"db_language_id": "a62005a2-389e-4dac-8791-e1536766eaef",
"db_language_code": "sample string 7",
"db_title_id": "7da350f6-ffee-4695-bd66-6508ab56bfdd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-16T05:10:12.3232006+00:00",
"create_date": "2026-02-16T05:10:12.3232006+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-16T05:10:12.3232006+00:00"
}