Retrieves all the contacts
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": "924702f7-6a58-4037-93c7-c9510c29ae68",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4b317ee0-6d1b-4ec4-af41-0b29721178ee",
"company_code": "sample string 5",
"company": {
"id": "4260f2a6-8f51-42ab-84f0-7a61b5a19896",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-19T00:10:57.5766401+00:00",
"sales_territory_id": "c7b1efe6-d5f4-493e-9282-58b31007a522",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2e416127-ad01-4486-9348-ca7a17829c71",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9926368f-1dc0-404b-a27b-f9b5cfa96c26",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4226024c-e554-4bf8-b946-c8a84b1f0b11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d1bda64-4cc8-4ad7-ba13-218cccd5dc95",
"db_currency_id": "e4d219b4-83cd-44bb-b84f-3e5a0be01f69",
"db_language_id": "9ea35c5c-7c83-490e-9709-8c427424fd11",
"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-07-19T00:10:57.5766401+00:00"
},
"modified_dateutc": "2025-07-19T00:10:57.5766401+00:00"
},
"marketing_segment_id": "5a86b00d-c2bd-4f1c-8be2-955c127e4175",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3d98b38b-b1df-43ab-9905-4fe301cf69e3",
"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": "cd0c114a-f335-4186-af15-ef0db80b7d91",
"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": "484da5e7-a98a-4276-ace7-d7de5428993b",
"db_country_code": "sample string 28",
"feelist_id": "66961045-b9d8-4d46-b1cb-6558dcca636e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0d2167aa-357b-4440-894d-11cb2ca3335f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8c94791a-2af0-4786-91eb-348540333398",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-19T00:10:57.5766401+00:00",
"db_currency_id": "72f077a3-f412-464f-b28f-0ece894183c1",
"db_currency_code": "sample string 10"
},
"company_type_id": "03fd0fda-d120-4adf-b162-bcbd4d9c0be7",
"company_type_name": "sample string 32",
"company_type": {
"id": "93706c71-f942-4ec7-8357-e0e6e8da728b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e7507836-53d3-4dca-b601-a26ab427515e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b0648703-7407-46fc-a3ea-9d8dfa9938cb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "85c1274e-59ad-41ae-81d8-677ac5c686e9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "de41c8bb-8692-4d44-92e5-1aaca05c3a14",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b4aacdaf-32f5-4643-8375-68478b9e0fdd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-19T00:10:57.5766401+00:00"
},
"company_sector_id": "0eeb4f40-dc60-42eb-9294-7102501a40ab",
"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": "3f6c8ba5-1ebb-4fc1-baa5-067165bb006c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8a54bc43-4954-4c20-9948-bf5c2494b3d5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6dde6c39-0b05-4e9c-9277-255c59b11fb9",
"account_manager_user_code": "sample string 56",
"company_status_id": "46276084-0f56-439d-b055-bd14b864d011",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-19T00:10:57.5766401+00:00",
"id2": 60
},
"db_language_id": "5a2a29e5-1ca6-48a4-9564-c4a86bb3570f",
"db_language_code": "sample string 7",
"db_title_id": "0d209978-81dc-4692-8ef9-38b73fb54e50",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-19T00:10:57.5766401+00:00",
"create_date": "2025-07-19T00:10:57.5766401+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-07-19T00:10:57.5766401+00:00"
}