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": "6a945a7e-1789-4c8f-8c1d-012107ade940",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e3d21a94-2733-4502-83e7-fa3fd62791ac",
"company_code": "sample string 5",
"company": {
"id": "9f7713f6-5cf3-4768-9e87-12f2c751042f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-04T10:30:55.7389173+00:00",
"sales_territory_id": "4411a061-3789-46d8-9164-72dc4482e141",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f9f88f7b-dc9b-4785-b0f8-388345a12644",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b4e6b5e7-4951-4915-8ffb-b8e49776af76",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6cc285d6-a74e-4aaf-a49b-8986ed2af0a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e2f00840-0d21-472c-910d-087135af1cb2",
"db_currency_id": "03b2f89d-54f3-442b-8e46-4bdeb92b96d9",
"db_language_id": "a54efb9f-a0f9-4f1f-bb6c-79207340c413",
"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-08-04T10:30:55.7389173+00:00"
},
"modified_dateutc": "2026-08-04T10:30:55.7389173+00:00"
},
"marketing_segment_id": "facc745c-cae3-4112-a83b-6c1bd1144493",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "85c8c507-382e-4659-a1d7-6fe367d78d14",
"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": "89b1c3ec-e9b5-4e5d-b4ed-573e0b66d012",
"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": "123d763c-b0f3-458c-94cb-ce97586c0620",
"db_country_code": "sample string 28",
"feelist_id": "3f375619-fb67-466a-addf-3b910729fd87",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "333f0c51-02b8-414d-b1e2-43ce340d44bd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f8d428ac-a1e4-455c-b6dd-6275f126abb6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-04T10:30:55.7389173+00:00",
"db_currency_id": "5e9582b8-ba49-421d-a0aa-1eaa0e06f33d",
"db_currency_code": "sample string 10"
},
"company_type_id": "263d7d8f-8fd5-4cb1-9a63-2aa512b32ef1",
"company_type_name": "sample string 32",
"company_type": {
"id": "1d17d0b7-ff9d-4d4c-b279-d4e4435fc38b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ce659b0b-80b4-4395-a5ad-465fb6563c50",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2f0f08f7-268f-4919-8e82-c5391b1a1187",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4f6d3ccc-ffcc-454c-a750-b1cdbe2ba251",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4101becb-9d58-4e51-a196-2e7cca639ea5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d25c146d-bb1e-43d1-a3c5-93705f459b3d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-04T10:30:55.7389173+00:00"
},
"company_sector_id": "e1db321f-4128-4d52-9902-e6934bae35e0",
"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": "fb14fd49-a6f7-4ebf-8e10-46fb54727c2d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d27f7c6f-dce6-4f40-8c1f-43635ba526e8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "53b6a8ba-cf38-4c1f-8e14-cfcc8074ad62",
"account_manager_user_code": "sample string 56",
"company_status_id": "464ea67b-9d12-457c-8ed1-4efac74dfa2d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-04T10:30:55.7389173+00:00",
"id2": 60
},
"db_language_id": "557f2986-9218-4118-b1ac-bde1f8adee48",
"db_language_code": "sample string 7",
"db_title_id": "7f2efc89-d3e1-43da-b185-a3c8a01cf98e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-04T10:30:55.7389173+00:00",
"create_date": "2026-08-04T10:30:55.7389173+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-08-04T10:30:55.7389173+00:00"
}