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": "a9bee3c1-c398-4f65-994e-cd3645cc1984",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "476b049d-b6f5-444a-8b60-6d611132dcb4",
"company_code": "sample string 5",
"company": {
"id": "e40340e4-050d-4937-9ca9-259bbfbec277",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T05:37:06.966391+00:00",
"sales_territory_id": "b57a51c8-d3e9-4d38-aa0e-d9f86f4b35fe",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "12e70290-8f49-4417-851b-120037fb8ff6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1b1e7e61-f95d-4263-a010-3efc764762b6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b2999299-bc39-4bca-a04b-e962bd998c2a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a1c03521-eeb2-4de3-82c2-fd3e3af29d0e",
"db_currency_id": "4e9fbbab-d471-4171-81e2-9f1e38e928cd",
"db_language_id": "be70b87f-c237-45b5-860a-bdcf6d536819",
"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": "2025-08-12T05:37:06.966391+00:00"
},
"modified_dateutc": "2025-08-12T05:37:06.966391+00:00"
},
"marketing_segment_id": "df0813d5-db58-469f-944b-08a627f52c79",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "df69e8cb-cac4-4a7a-9ac6-072afeccee8a",
"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": "8071859d-a927-4848-abe9-ad1e843d3dba",
"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": "501fe607-1bd6-4070-ab4d-3e3852f32ff1",
"db_country_code": "sample string 28",
"feelist_id": "4e702b14-3836-486e-aa45-389038ee0b97",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b4173e06-cbc6-4488-8208-4662cd69da36",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "75678a44-717c-48f4-85be-2e99db022e7e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T05:37:06.966391+00:00",
"db_currency_id": "2401bff4-4968-4dcf-a52b-00f8f4e837c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "224a695e-abc4-4c32-a47e-1e41bd33af2e",
"company_type_name": "sample string 32",
"company_type": {
"id": "7ffde77e-036f-4e53-a01b-9b1ec1a34a0d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7396d768-8b73-408d-96f4-c6e7efc3c55b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "704bfc82-2eea-4b7c-8078-897ebb1d1cf9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1c82adbb-5fa2-45cc-b1f3-e723e73e8f55",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "44ab354b-50fa-4b6b-9a1f-f92542e33069",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "faa35e89-2a34-4836-a616-83f7f6e5873b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T05:37:06.966391+00:00"
},
"company_sector_id": "d1679440-2078-4b04-abe3-6e046a4966cc",
"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": "377f7b10-c2c5-4815-9f25-997efc011a75",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fa932a56-241a-4ecd-b415-1adbca409e2a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "14be4aea-db35-4130-9489-079eb5f05f5d",
"account_manager_user_code": "sample string 56",
"company_status_id": "0932d149-18d0-446d-9d2a-c9c3a6ad173e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T05:37:06.966391+00:00",
"id2": 60
},
"db_language_id": "7d1adedb-f250-4df5-a62a-1f3cc76897ee",
"db_language_code": "sample string 7",
"db_title_id": "710b18ee-7edb-4e3c-a210-30570dc49ca6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T05:37:06.966391+00:00",
"create_date": "2025-08-12T05:37:06.966391+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": "2025-08-12T05:37:06.966391+00:00"
}