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": "d3e844fc-d2ae-44d6-b69c-f18b73ca617c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a6cecffc-f8df-4e1d-9098-63a26819e0c2",
"company_code": "sample string 5",
"company": {
"id": "82594e0c-ae23-4e82-a8b3-e51854e5399c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-06T14:57:53.4690617+00:00",
"sales_territory_id": "fc380509-0ee0-42bd-85a3-d5e232b9b5a8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7be60351-7445-408e-90fc-e68933594e73",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4134cea1-ec04-4769-96d8-482e6d7f9614",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "56b7aad9-fac9-4701-8696-8675a6522827",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "acddeed3-d0ae-41df-9396-5cb80433042b",
"db_currency_id": "64de84a1-761d-4dbc-b4ba-19ac6333e29b",
"db_language_id": "7bd94ba5-748f-4986-a7d2-62342d8860c6",
"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-06T14:57:53.4690617+00:00"
},
"modified_dateutc": "2025-11-06T14:57:53.4690617+00:00"
},
"marketing_segment_id": "a259571e-cadc-4295-9cef-843afbfca6e0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "22bdc13d-ead7-4725-b129-b4d0000ae143",
"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": "f0f5273f-c323-41f8-b5a8-fcdd34659083",
"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": "09ab42c4-afa5-4685-bcdd-4cce27d4bfff",
"db_country_code": "sample string 28",
"feelist_id": "c6b54c0a-b3c6-46f9-9ee3-a4d6f6b0878c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6823a7db-85f3-4725-9852-8877bfeba0cd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1fb133cd-2eb8-47fa-9ecb-d61df3b761b1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-06T14:57:53.4690617+00:00",
"db_currency_id": "778084a7-b9cc-4815-bdce-1545982b0f6e",
"db_currency_code": "sample string 10"
},
"company_type_id": "ba2a78d6-94b1-4e06-a15e-394eedaa5872",
"company_type_name": "sample string 32",
"company_type": {
"id": "379e1ff5-ec30-46f3-afcb-4dd12bfcccbd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6ac7fc8c-79d2-4310-a365-c152079865cf",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9eb1b6fc-aa95-4c9a-8ab4-0eab57b6c6de",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2b4ace9d-35a6-42fc-aebf-40db7d22a8af",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9f0126c3-3465-488e-826a-0f72447a1fdd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a121789d-0a33-428a-9b4b-936feac5a427",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-06T14:57:53.4690617+00:00"
},
"company_sector_id": "b0ccdb86-871a-4525-b725-2311b0ad8c83",
"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": "6358c3d6-3363-4aa3-a86f-ee051bddcd78",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "737cc8da-2679-4fa7-82b8-86a9be67b21e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ede1ee6b-a4d7-43be-b021-18e87591af26",
"account_manager_user_code": "sample string 56",
"company_status_id": "b7772069-80a5-4b1b-b3c3-5537102ffcfd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-06T14:57:53.4690617+00:00",
"id2": 60
},
"db_language_id": "1d700a28-6956-4317-823b-7357f9d57b9b",
"db_language_code": "sample string 7",
"db_title_id": "b7449f6c-e28c-40b1-9055-cf398f38758f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-06T14:57:53.4690617+00:00",
"create_date": "2025-11-06T14:57:53.4690617+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-06T14:57:53.4690617+00:00"
}