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": "b6f3de9c-e4ed-46be-b883-d15552e4e1ec",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e7d572b2-264e-438a-b5bc-49bd6aa88d0d",
"company_code": "sample string 5",
"company": {
"id": "25b8ddc4-8982-43dd-8451-50b5efe7afa4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-30T14:10:49.1025164+00:00",
"sales_territory_id": "55c52fe4-972b-4074-997e-3cb19c51a515",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3a529c18-cf08-4bbf-8d03-5e1bc5a9b0ef",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6e6cc705-613a-4a3f-8e68-43b701475d3d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e70b8e49-7f96-4ff3-9f98-0cafbf3f8987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23f915d5-0c02-4ec6-aa9c-de6f762075c3",
"db_currency_id": "bdcf077d-e587-4cbd-afcb-d48512c137f0",
"db_language_id": "28554c4d-f081-45d2-b2dc-54ccb7cf657b",
"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-30T14:10:49.1025164+00:00"
},
"modified_dateutc": "2025-11-30T14:10:49.1025164+00:00"
},
"marketing_segment_id": "b5595244-c879-4a1c-9547-6ab9330c0758",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "27d3d227-ea97-41cd-9865-381114b84c38",
"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": "77a74374-7ade-4117-8de7-4e67609157a6",
"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": "6489a78a-7b21-45ab-9cf3-f99dc9650c6f",
"db_country_code": "sample string 28",
"feelist_id": "360b9790-e0bf-4b82-ac5d-e9dcb6ee592a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "4dac1d20-c2d9-45c4-b43d-6acfbe7263ba",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a79ed3bb-0f6b-4e4f-ba50-67e502093ac6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-30T14:10:49.1025164+00:00",
"db_currency_id": "f87391d0-0fdb-44d5-87b3-874475c79e23",
"db_currency_code": "sample string 10"
},
"company_type_id": "f2925ed1-6aaa-4e9f-88cb-1ab295fa28f1",
"company_type_name": "sample string 32",
"company_type": {
"id": "931fcc82-1626-40c0-9472-d08f4c4587e2",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0002519a-0dbc-4879-9bd3-945f86ef4f7e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ac5a7499-b3c0-45fe-a7c0-e671c944b34a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2a6b9d11-1e01-4aff-af71-86e9446194fa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d9b7d258-a2b8-4b49-b182-090603e38fd1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1a4f61e9-f483-49ff-82fe-b6cadad87007",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-30T14:10:49.1025164+00:00"
},
"company_sector_id": "c38b7279-9b07-4f02-9e42-860afb3aa88d",
"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": "28c8176b-c4c9-4915-b7d7-056a56bee5fb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "28adba67-a3d3-4edd-ba7e-a34e0be08f88",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4c8034ad-02ee-46c4-b525-d279c0cc8ad6",
"account_manager_user_code": "sample string 56",
"company_status_id": "0756ad6a-d9a9-4607-9caa-a88a40edc00d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-30T14:10:49.1025164+00:00",
"id2": 60
},
"db_language_id": "9974767f-22b9-458d-978e-1e492b36fad4",
"db_language_code": "sample string 7",
"db_title_id": "51839ece-27f4-42c2-aec2-df24950252e2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-30T14:10:49.1025164+00:00",
"create_date": "2025-11-30T14:10:49.1025164+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-30T14:10:49.1025164+00:00"
}