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": "7fe2a4f8-e883-47f2-8cd4-efc5b9d5f9ff",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6572a4dd-f218-466c-90d3-f55a9dbf2f00",
"company_code": "sample string 5",
"company": {
"id": "5aa9e6b4-e570-4359-8141-6291be6dee58",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-10T05:12:38.275394+00:00",
"sales_territory_id": "bd2e4e84-b92a-4f86-b3f3-695f2a5a91d4",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8c77da75-4919-445c-8e6d-6ccf61653d8f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a7da32df-96e3-4ea3-a767-463810484e4b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2009614b-9ec9-4c23-b7aa-b5882bcdd72a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bc9ab5fc-0ff6-4993-b1f4-1797325e0a61",
"db_currency_id": "1058aaa2-aba5-49a6-bb93-1b7acc148500",
"db_language_id": "05aa60ae-ec92-43de-a25e-20b7ba9ff750",
"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-12-10T05:12:38.275394+00:00"
},
"modified_dateutc": "2025-12-10T05:12:38.275394+00:00"
},
"marketing_segment_id": "749d7c69-654e-40c8-86d4-9123c5e52008",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8bf27eb9-6d7e-4e3a-8433-38a83be6a8a4",
"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": "72dc5160-19af-47e6-a98b-31447382cc6f",
"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": "51fdb679-75d2-40eb-bd02-7a9e2d5648e0",
"db_country_code": "sample string 28",
"feelist_id": "0adef32d-786d-4b07-893c-cba3d0d57525",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "29d1fddc-13a8-46e2-9005-03eeeaa78794",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c04bdd25-92c5-47c9-8798-6f0296242936",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-10T05:12:38.275394+00:00",
"db_currency_id": "d1b1ebb7-d854-4b4b-82aa-1ad76f05b034",
"db_currency_code": "sample string 10"
},
"company_type_id": "f66270f6-7832-4293-beaa-226bf0534437",
"company_type_name": "sample string 32",
"company_type": {
"id": "41454231-9ee3-4c4f-962d-5930a4b72ea3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "589bf03b-1182-48ed-9442-415ed19e6495",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3222c904-7027-45de-bffb-4cb4d6065a71",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ab6856cc-12f2-482c-9f82-000c89f0ff98",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e79d448e-8d3a-40fa-9c6f-0e844c9f39db",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4e889f96-3d84-4039-a93b-6eb1187a0d9a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-10T05:12:38.275394+00:00"
},
"company_sector_id": "f7db00cc-f390-41f4-84e2-450c2bf67bd4",
"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": "99e58896-c8ab-4c46-a9a2-a6bb63d3f4f7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4a4c3e39-a4fc-4cbf-be64-9828b6d811cc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2fcd15e6-b06a-4607-983d-0769fce342e8",
"account_manager_user_code": "sample string 56",
"company_status_id": "e4ec9f75-b349-4780-9537-8c604cadb507",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-10T05:12:38.275394+00:00",
"id2": 60
},
"db_language_id": "505dff93-34c5-407e-ab26-1052e7bc24d0",
"db_language_code": "sample string 7",
"db_title_id": "c85c25ab-aaa1-4ea6-9cd3-a6e35b1328ac",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-10T05:12:38.275394+00:00",
"create_date": "2025-12-10T05:12:38.275394+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-12-10T05:12:38.275394+00:00"
}