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": "050a6e33-539d-4d7e-bafc-73f98bfdd693",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4b621f7c-ac55-4ae9-a620-0b4d09d0494d",
"company_code": "sample string 5",
"company": {
"id": "a858c853-fd76-44c3-b513-1c08b5cb8c54",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-18T05:37:02.849802+00:00",
"sales_territory_id": "3bdbf920-ce07-4614-af8b-26829ad1c07b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bbf7a5ed-66e8-41e2-bbc1-77f613c04862",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b7e9aed9-5dd1-4a2b-8ea4-fd1e26a02114",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8d7d6233-354e-474e-8bd1-bc5eec095ae4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c44767-2d5c-44a5-afc7-b25bb47b871a",
"db_currency_id": "44cda881-2a7e-4679-9434-499847bf8a96",
"db_language_id": "2ed1706f-9e76-4460-86e3-9da12401a806",
"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-18T05:37:02.849802+00:00"
},
"modified_dateutc": "2026-09-18T05:37:02.849802+00:00"
},
"marketing_segment_id": "eac41c31-31a8-4cd1-b804-b894c5e58af8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "62160bf0-239e-4d09-9c29-6d3e305ac5b7",
"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": "3ebe0a27-4152-445a-85eb-b4f60a80dcad",
"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": "26e2b6fe-070b-4968-9621-66ea9c640b42",
"db_country_code": "sample string 28",
"feelist_id": "ca68ff48-0b67-4d25-a4c2-022ed8c7888d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4901839b-189f-486d-a47f-b95e853611f3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "beccfba5-82bf-4626-a575-334b92f717f8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-18T05:37:02.849802+00:00",
"db_currency_id": "64bbe800-cf15-4853-aff7-6d9195b27e6b",
"db_currency_code": "sample string 10"
},
"company_type_id": "94574669-45b6-4925-9bc1-1dc2ca944489",
"company_type_name": "sample string 32",
"company_type": {
"id": "0ea549c5-87d6-4eba-8ff7-7fa622ac9c30",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dd96a5ce-6827-4382-981c-d9800cb13cd6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "605886d7-1f79-4df8-93d9-6a62679812a1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a0169f94-2e03-4cf1-9c26-acaa4c8451b4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d653014e-481a-4263-9df7-468d0582a794",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1ce2af2f-ca57-446d-9577-2c2cf784cb69",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-18T05:37:02.849802+00:00"
},
"company_sector_id": "3efc2893-eb6f-4701-961a-08fc1552e8ee",
"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": "c18d6ec4-ff75-45e9-b85d-dcc7c02b9658",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3bf030e5-c561-4c7b-963d-6829676d391f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f8b9a49c-274c-4458-bd7d-3fc1758734e8",
"account_manager_user_code": "sample string 56",
"company_status_id": "c4323807-6414-41a5-9fc4-1fa00a5ed65a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-18T05:37:02.849802+00:00",
"id2": 60
},
"db_language_id": "7d6d00c8-2152-4f66-a673-dd6c69066d6c",
"db_language_code": "sample string 7",
"db_title_id": "efc36b2f-90bc-4613-ace8-09edca568b18",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-18T05:37:02.849802+00:00",
"create_date": "2026-09-18T05:37:02.849802+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-18T05:37:02.849802+00:00"
}