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": "1bdfcdc9-d275-4809-b16a-9a84c10710ed",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "572c0ece-8095-4f51-9219-f4ed635b244a",
"company_code": "sample string 5",
"company": {
"id": "259d5404-b5b3-443f-9811-b4d9f7774263",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-04T13:15:02.3625763+00:00",
"sales_territory_id": "b375b8c6-53e1-48a4-b862-db5ff6304892",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a39e61b4-9854-4e07-88be-ec29f276274d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "760728ff-e488-495c-a403-c2555aa6976a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fbcc4855-6b81-473d-a102-7f8e78f7c6e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "728c4c15-fd13-4d4b-83c2-fd93ac6f09a9",
"db_currency_id": "0b19de81-77f2-4214-b6b1-60f155409819",
"db_language_id": "d21cad41-ead2-43bb-9eba-ee783d052f91",
"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-08-04T13:15:02.3625763+00:00"
},
"modified_dateutc": "2025-08-04T13:15:02.3625763+00:00"
},
"marketing_segment_id": "2c009540-9df3-46c2-8ff8-4eecbd2a889f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e3d6a2b8-b5c5-4ed5-b9b2-beec6f4c2b9a",
"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": "12e335bd-5505-4e03-b4ba-716344c7e760",
"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": "37cc441f-c0f6-40e5-aecc-846859165640",
"db_country_code": "sample string 28",
"feelist_id": "45939794-b335-488a-9e5d-5377e368ddad",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "773ca2e2-87dc-4d42-bad0-96b0b4c5700a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "046084b2-44a3-47b6-b135-f4d1475f3b83",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-04T13:15:02.3625763+00:00",
"db_currency_id": "4df03f3d-3530-4598-be0a-81c00e3722df",
"db_currency_code": "sample string 10"
},
"company_type_id": "d647c497-e6e5-4c72-8e84-1da3adb4a761",
"company_type_name": "sample string 32",
"company_type": {
"id": "35a5a494-a6f8-411a-a5bd-cd4c244138f7",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "853cf457-f5af-4388-8f9f-25138cf59461",
"sales_organization_code": "sample string 5"
},
"db_language_id": "cca5595d-ef2b-465e-aea3-a25b0e5933d5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e9d13c3d-232c-482d-87dd-91a992b4eea6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "2da26fac-4930-46b8-8824-20bfc8f47c13",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "01731f1b-c8a9-4143-aad5-71fbb4d1a047",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-04T13:15:02.3625763+00:00"
},
"company_sector_id": "f2d7ce34-1fc1-428a-8108-dbce92778b0b",
"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": "c4f8c3a0-6b1b-4290-827d-0134e8930d7d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "95d3545c-27ec-4e16-98da-7c4ae4173a9c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3b19ba57-5355-417a-aa32-bc3dc6c5fe23",
"account_manager_user_code": "sample string 56",
"company_status_id": "d3690ac2-39b3-4769-9fc7-3741387293ae",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-04T13:15:02.3625763+00:00",
"id2": 60
},
"db_language_id": "316af165-5c01-4e4f-9900-748ab53f962b",
"db_language_code": "sample string 7",
"db_title_id": "fd539ee0-fe2d-4382-b606-690319d712dc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-04T13:15:02.3625763+00:00",
"create_date": "2025-08-04T13:15:02.3625763+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-08-04T13:15:02.3625763+00:00"
}