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": "7871ceae-58bf-400a-a36c-e094442bb423",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2779de35-150b-4f1b-bab3-85779c87135e",
"company_code": "sample string 5",
"company": {
"id": "fd307025-affc-49fb-9648-7cabf83290cc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-10T16:31:48.5021828+00:00",
"sales_territory_id": "c19305de-f2e6-4381-a21c-7a2b8fd54459",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e7f91865-1c04-406e-be01-6fa39279ca2d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "409c3309-7768-412c-bc33-21b361dc7881",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "083fc1ae-2ddd-41d0-a188-54eee3517110",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa908ce9-d939-4d5c-a68a-140cf96a01dd",
"db_currency_id": "b60503af-9700-41a7-81e8-9d81ac182442",
"db_language_id": "50a62efc-eaae-43ca-a710-66fa53f98d1e",
"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-12-10T16:31:48.5021828+00:00"
},
"modified_dateutc": "2025-12-10T16:31:48.5021828+00:00"
},
"marketing_segment_id": "92f3117c-2763-4f41-8562-b1235bd80e13",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d926e9a8-a651-4f5d-9010-6bb92cbd800e",
"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": "eb241ae9-8b19-4149-b020-9ebd406fcf7e",
"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": "1fe37a0b-4e1f-41dc-8d68-10ec64aa5217",
"db_country_code": "sample string 28",
"feelist_id": "457bc113-1e79-4061-88f7-3703ec5bcb92",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "978979f9-574e-496e-9d52-894fc32d8df2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "372ba49f-0fe2-4af3-b359-a43163d5fa67",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-10T16:31:48.5021828+00:00",
"db_currency_id": "22d8d87b-081d-4df5-ae06-8dc6b571a2fd",
"db_currency_code": "sample string 10"
},
"company_type_id": "429f637c-3dcd-4d6e-9e47-db3e4aae474c",
"company_type_name": "sample string 32",
"company_type": {
"id": "ef4a1477-7a77-4aff-a4ce-23bada65db5f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bc52d91f-9871-4592-9a00-71088e6310ac",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7ed2dc0f-403f-4197-83f7-3c7730f3e75e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "308ba764-f23c-4391-b1bf-380d1397c319",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "767477a9-af49-41c0-9d4b-b14d56b48ad9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c247b038-4aab-4345-b9e3-1b4fc848599f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-10T16:31:48.5021828+00:00"
},
"company_sector_id": "8653bb3f-c70f-4ed5-b1d4-a0badf4320b4",
"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": "f08cdc51-bf82-4fc9-a800-ad7be7353961",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0d5f70b3-a5b1-481c-9565-1ed2f9050ef2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "66728d5d-17ce-4f78-8f98-8eaeba966002",
"account_manager_user_code": "sample string 56",
"company_status_id": "c5f2e493-78bb-4a21-a5e5-d80ef5f7848b",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-10T16:31:48.5021828+00:00",
"id2": 60
},
"db_language_id": "871ba986-720c-48d4-8a3f-c6e49bc7c7b4",
"db_language_code": "sample string 7",
"db_title_id": "738da706-a5f6-4e30-95c5-d324a0dab17a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-10T16:31:48.5021828+00:00",
"create_date": "2025-12-10T16:31:48.5021828+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-12-10T16:31:48.5021828+00:00"
}