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": "93cddcc9-6dba-49a2-a9ee-0aff400db837",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c566d9d6-0c2c-4d62-ac54-79ef958b8e35",
"company_code": "sample string 5",
"company": {
"id": "c552ca33-b64b-401b-9e44-1dae75eea1cd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-12T12:07:15.7723716+00:00",
"sales_territory_id": "65e4642d-6e68-4a7b-a10a-e9fc8306e7d8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8e3cd653-27c6-44c9-a142-82d80f2577c5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "964578f0-94b0-41ae-989a-51cc1f8e6d87",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "77ed52b5-98d0-48b5-a2ac-2c2cd800bd34",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dc2e2a10-c65f-4282-a2c4-731252b64e46",
"db_currency_id": "cdf49f10-1b34-4e52-be44-b7c6fbe86c60",
"db_language_id": "1bc6a4d6-c9a8-40fa-8f7b-2e93c5ef5e42",
"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-11-12T12:07:15.7723716+00:00"
},
"modified_dateutc": "2026-11-12T12:07:15.7723716+00:00"
},
"marketing_segment_id": "8bd0bb05-2335-47ab-8994-457323faf75d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d383e594-7547-4e91-bf28-fde31a9cb5fb",
"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": "870c703d-9800-42f2-8aec-2be9442dfef7",
"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": "47c85667-6a0f-4fec-957f-2cedafa1242b",
"db_country_code": "sample string 28",
"feelist_id": "70dc8a1a-5053-44d8-88a7-f0a479b169d4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f72b12c5-da00-4c7b-ba65-a3c7d18270dd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "089e3ae7-6627-49ac-b060-6b27c4df981c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-12T12:07:15.7723716+00:00",
"db_currency_id": "47228963-3c53-4ab3-8e22-fec0f31a39e7",
"db_currency_code": "sample string 10"
},
"company_type_id": "4a0a5e33-9ac9-4e1d-9757-d87d06352439",
"company_type_name": "sample string 32",
"company_type": {
"id": "1b41104f-2e10-4b87-a054-4ff264728f4a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a2653b36-ba99-4f03-857b-6ba4a7f40a41",
"sales_organization_code": "sample string 5"
},
"db_language_id": "755c725e-e00e-4899-9472-6c8ebd57cf81",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0a833269-cd47-4ae0-97d7-a32a665eeb42",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "186b2f96-3c44-47c4-9c81-55ae95e96596",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cd606f19-f92f-43dc-92c9-38c77d432a23",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-12T12:07:15.7723716+00:00"
},
"company_sector_id": "5a7a9d8e-7cf2-4707-9ee8-cb8455eb89cf",
"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": "938b0946-6edf-49fe-aad5-9d84d3aba6c7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "81c5dc6d-6cc1-473b-968c-626146d5fcb9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b5e3165d-aca5-4154-b69c-9d00ff1f0a2e",
"account_manager_user_code": "sample string 56",
"company_status_id": "23b18a05-c6b1-46e2-9a78-091a0f798688",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-12T12:07:15.7827201+00:00",
"id2": 60
},
"db_language_id": "6765b4d0-54b2-4550-acd9-7528ad1a022e",
"db_language_code": "sample string 7",
"db_title_id": "7b359580-696e-4f4e-8d01-1ea681734c68",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-12T12:07:15.7827201+00:00",
"create_date": "2026-11-12T12:07:15.7827201+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-11-12T12:07:15.7827201+00:00"
}