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": "5e47e6e5-457a-4137-aa86-15dcda393812",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "83ac3422-0abe-49f2-9b83-15e64dcd7c48",
"company_code": "sample string 5",
"company": {
"id": "d325cbec-f977-495f-8378-17c42922548d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-25T19:52:58.5409302+00:00",
"sales_territory_id": "8ac392a8-a222-4c79-9a07-8e084526bfa1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5932b608-7bf6-4d0e-98cf-8382489a37a7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e099aaf0-d361-4c41-ad5a-8e38d727c317",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "57431a35-7884-4892-b674-0265cf8078aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fb2dbfd0-a668-4745-b161-f01ecfc939a0",
"db_currency_id": "74615f41-b997-4158-808a-d39b9cce1b37",
"db_language_id": "492a93c8-567a-439e-a9f2-99c21b90797f",
"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-11-25T19:52:58.5409302+00:00"
},
"modified_dateutc": "2025-11-25T19:52:58.5409302+00:00"
},
"marketing_segment_id": "0d457bad-ff36-4191-842e-188bbf7a48d3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ff5a1f28-9099-470e-b600-f89d9aa27658",
"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": "b3b68ecd-8d51-482f-8b56-689ba87bfb14",
"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": "45a019f7-64ec-47d0-a1f4-f9e54618b0f5",
"db_country_code": "sample string 28",
"feelist_id": "54b4b176-bc57-4948-b38e-8efa738f5bbb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "17fe2fe3-f3d6-4294-9c5d-a82c00b8c78c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8d52258e-eafe-4250-a018-3e72f1d9258e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-25T19:52:58.5565483+00:00",
"db_currency_id": "738e38d7-55a8-4a60-8d8c-11932d2d98c5",
"db_currency_code": "sample string 10"
},
"company_type_id": "492acbef-11ad-49eb-a12e-db5ee7f1253f",
"company_type_name": "sample string 32",
"company_type": {
"id": "910158c0-3340-418d-b01c-2f2ac33d3a0d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "038e70f3-e396-4676-8ea9-4820ae193371",
"sales_organization_code": "sample string 5"
},
"db_language_id": "96fe61bf-dbc8-40f5-8f6c-965b40bca098",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8953a138-5139-4c56-996b-d057b6d82acc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "10bea2cc-b221-4a39-806d-9ce76b03a168",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4bd35d7f-7f8e-4461-8bc0-7421e3031f92",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-25T19:52:58.5565483+00:00"
},
"company_sector_id": "8dc4c505-b226-4294-907e-4f4bb807cc30",
"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": "645dbce4-cf71-4c3b-98d9-f2ba65971017",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9260517e-69e6-433c-90ec-10bb40aec1c4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b8a83dd5-e79f-46d1-9be5-3769eee8320f",
"account_manager_user_code": "sample string 56",
"company_status_id": "c3d17e21-6ad7-43e5-ab2d-9106f47cac38",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-25T19:52:58.5565483+00:00",
"id2": 60
},
"db_language_id": "af8d4c9b-a8c5-4795-9190-a676cfc45df9",
"db_language_code": "sample string 7",
"db_title_id": "e5be6228-1413-4f5f-a987-ec48798dc77e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-25T19:52:58.5565483+00:00",
"create_date": "2025-11-25T19:52:58.5565483+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-11-25T19:52:58.5565483+00:00"
}