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": "520becf6-8dfb-436f-a6b1-de031302590f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bc00da5e-eae4-47be-bccc-a3af7e9d8a68",
"company_code": "sample string 5",
"company": {
"id": "abe3c965-28e1-4e1b-be9a-19d4174ac71d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-14T07:16:32.3234943+00:00",
"sales_territory_id": "a6c33d9f-4277-4983-b393-28c31aa25218",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "51f5df64-1aaa-49da-9db5-7569a4433891",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c9e8837-cf2d-4650-820c-0040c5c10569",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "37df4374-eab5-4995-9e55-e0d30d3131e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03bd344b-0483-4e77-8e67-267b50d0b7dc",
"db_currency_id": "a5469b9e-040d-4191-a9f4-de7168b27647",
"db_language_id": "f7740fba-def6-4392-a8b8-9fdb109af28f",
"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-14T07:16:32.3234943+00:00"
},
"modified_dateutc": "2026-09-14T07:16:32.3234943+00:00"
},
"marketing_segment_id": "cf02cb6f-810f-488d-9d83-88a26afcd589",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fa5aece8-b691-4092-8d96-4fd426410001",
"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": "15a639be-c29e-482b-a4a0-f3a7b5ae8aa6",
"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": "f274e536-e8b4-4758-a75f-52b9c1e6c697",
"db_country_code": "sample string 28",
"feelist_id": "ccd4e240-0c63-4a65-a95d-edad12df538b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d2e7797c-d183-42b9-9c5e-2ca83767a5e6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c799c5a1-0ea4-4145-bb54-f0522327adc2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-14T07:16:32.3234943+00:00",
"db_currency_id": "c922f5c7-6fe8-434f-a46a-de8127477ea8",
"db_currency_code": "sample string 10"
},
"company_type_id": "25ca2156-7358-4790-b1a5-02f6cec457a8",
"company_type_name": "sample string 32",
"company_type": {
"id": "ee16281a-decc-4ff8-84d5-4e4de29b5794",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9c3b1a86-0b5c-4493-899d-cba3638eaa75",
"sales_organization_code": "sample string 5"
},
"db_language_id": "029a3141-a730-4c49-b19a-623fe4c77010",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "326fe891-fe6c-410a-a468-c93acda59069",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d5da1a3c-e998-43e1-b187-83880a553350",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9ddf186e-5cca-4b2b-9ef4-931dfeddb7d3",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-14T07:16:32.3234943+00:00"
},
"company_sector_id": "1b12722f-f755-449c-9f2f-ff62a4e89438",
"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": "fc77af0c-5779-42a8-ba6f-6f742352de7c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "edb79b0a-d591-4d8a-8b35-ed9cc00a0547",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "059e470b-27a1-4320-a83c-ef4b4fd2a778",
"account_manager_user_code": "sample string 56",
"company_status_id": "5d5a23d5-47ae-40fc-b169-ae31f32578b9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-14T07:16:32.3234943+00:00",
"id2": 60
},
"db_language_id": "5f0bc39a-73ff-4b02-9acb-39d05b610606",
"db_language_code": "sample string 7",
"db_title_id": "4b7761a2-56d1-4d98-b359-07a1c4ca6846",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-14T07:16:32.3234943+00:00",
"create_date": "2026-09-14T07:16:32.3234943+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-14T07:16:32.3234943+00:00"
}