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": "4c24458a-5ec2-4580-bdec-44dd14e0fe06",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b6c98c1a-e400-42c2-95b9-9a04774201d0",
"company_code": "sample string 5",
"company": {
"id": "34354737-a418-45f2-98cb-7ad21102b43b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-01T15:03:06.5950195+00:00",
"sales_territory_id": "cfce6ab0-4707-4115-9ca8-0fea3db4835d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "95f397ac-2413-46c4-85f0-92b134fc36e8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c4034fdf-175f-4a37-9df4-c00a3029aa50",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f6de136e-95ae-4d6f-b0c5-f53468815797",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ef12c83c-3023-424a-84d2-3e9c322fd8dc",
"db_currency_id": "7caf85a8-5acc-487e-984a-4feadb4e8eac",
"db_language_id": "d06aa07e-739f-4915-bae7-0f81683c161a",
"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-02-01T15:03:06.5950195+00:00"
},
"modified_dateutc": "2026-02-01T15:03:06.5950195+00:00"
},
"marketing_segment_id": "5a2380d6-ad82-40c1-b1a6-8bc7ee899665",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f16254bd-2bf2-4857-8222-5bcce6968157",
"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": "9b940fe9-c9de-4a0e-8629-a276ddd9993b",
"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": "bfbfca1d-aa6d-4cea-87c6-df9c09aae7f9",
"db_country_code": "sample string 28",
"feelist_id": "3a79a62b-1f2d-4e78-a2c6-90ca93aa3561",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d6cc2d7c-c28e-40d9-9d23-bf3b39b8e1f3",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1a6f3c0f-ef12-488d-aa44-68728ccb8954",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-01T15:03:06.5950195+00:00",
"db_currency_id": "29bcc4f7-b6db-463f-9fc3-4579e5700624",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2bba329-be4a-49d0-87cf-9868fadb7142",
"company_type_name": "sample string 32",
"company_type": {
"id": "59306bf1-0a5c-44cb-b8d9-29d6aa5779da",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "18aa7c1a-a9c9-48f5-92ea-7744cac924dd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7812660b-27ec-42ca-a267-f2ff0331fd36",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c82d3766-3781-434a-80d2-599649afec17",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "513577c9-ce7c-4139-85bf-a05ef04167d5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c4385015-b986-4e2a-b31e-d65d6ab27f93",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-01T15:03:06.5950195+00:00"
},
"company_sector_id": "4bc390da-b118-426d-b9f8-0d82397f93c2",
"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": "19c5923f-c143-4e52-bc04-c801032a079a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3d760c29-f3a6-4aad-a9d8-80be347ec29d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "37c98a9a-1298-45af-a3e8-56a12e830f45",
"account_manager_user_code": "sample string 56",
"company_status_id": "4e2624ee-e866-4b8a-91c3-ff2723882c1d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-01T15:03:06.5950195+00:00",
"id2": 60
},
"db_language_id": "90b56526-ef51-408d-b764-44905cefb5e7",
"db_language_code": "sample string 7",
"db_title_id": "79ece2fe-35e7-4f3f-93e9-b71a358e4e9d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-01T15:03:06.5950195+00:00",
"create_date": "2026-02-01T15:03:06.5950195+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-02-01T15:03:06.5950195+00:00"
}