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": "2cd7c68b-e769-4890-b643-ec60497d2c92",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "99c41d4e-b524-4ceb-8484-ba9b4055b31b",
"company_code": "sample string 5",
"company": {
"id": "3664a978-9298-48bc-8409-16cf54b76ab6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-19T11:47:35.3253392+00:00",
"sales_territory_id": "32135beb-4f4b-4cad-a8bc-0a65fd5d7b58",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ddc336e4-3d11-4e7f-b3d8-781b546a3789",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8c812e3b-3caa-49be-b761-145bca591a95",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5365b7f-79be-4457-97d8-f6bb5c063bd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5941b088-1ed0-4fb1-a564-fe3bd2cc32f9",
"db_currency_id": "bc6a6c5c-b8bd-482e-a79a-7f6d819b5674",
"db_language_id": "58ba0906-55be-4636-bb7f-63f1349d2c8a",
"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-19T11:47:35.3253392+00:00"
},
"modified_dateutc": "2025-11-19T11:47:35.3253392+00:00"
},
"marketing_segment_id": "eacefd1d-66b6-4980-bb73-4d19cc519eed",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cff17f69-42ef-4163-b40a-4e85112ae918",
"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": "04030f26-9690-4b0e-bb2d-749cc3b662ae",
"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": "dfda9101-5a17-49b5-9af6-246dc28b52ab",
"db_country_code": "sample string 28",
"feelist_id": "4e38fe9d-b4d4-4136-b99f-e1fb1e43cda6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6ab1464b-a1d1-447c-b8ce-e76071376d36",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "615572f2-ca1a-4748-a211-4d69edba3e94",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-19T11:47:35.3253392+00:00",
"db_currency_id": "26ca9b5f-4276-47d1-86ff-4e0e4d432f44",
"db_currency_code": "sample string 10"
},
"company_type_id": "c3863665-7572-4025-9f1a-e318c4b65e39",
"company_type_name": "sample string 32",
"company_type": {
"id": "9649b5f1-1f94-464d-b409-013b2a3dd0e4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04038c89-1603-4225-bfa3-62ddaa18b58e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "99733180-db3b-4be9-be46-5a4ef9c76034",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "02bc55d2-a8b7-4e3d-a931-27d55a0798b4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d5bb5cc7-7864-4efd-9df5-49981fa5743d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "22f1630e-dcde-48bd-8cae-8a3dee603471",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-19T11:47:35.3253392+00:00"
},
"company_sector_id": "d8d08fd5-a678-4a35-b290-393493440d34",
"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": "c43479bf-892e-4e9c-94b4-c2ef5957e95a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2328ea48-4827-44f3-a3cb-0650930d990e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c3159381-cbf3-4349-934a-52c325b9cf85",
"account_manager_user_code": "sample string 56",
"company_status_id": "7fc3bbc8-a094-4eb0-9aec-cc6772ce7a6d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-19T11:47:35.3253392+00:00",
"id2": 60
},
"db_language_id": "620a8800-a802-4309-b019-11d651f1872c",
"db_language_code": "sample string 7",
"db_title_id": "4e82def4-bc1b-4a87-a9d9-91e38f5119b0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-19T11:47:35.3253392+00:00",
"create_date": "2025-11-19T11:47:35.3253392+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-19T11:47:35.3253392+00:00"
}