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": "8fbf89b4-8172-41cd-838c-95125edf537c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ee2e67da-eb31-450e-9f4a-7be8f2d141d4",
"company_code": "sample string 5",
"company": {
"id": "23f1f797-cb88-4044-a036-24a69bb541a6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-04T03:56:44.8625385+00:00",
"sales_territory_id": "a5b5920b-78bb-4772-9f01-096d781b8110",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3ba60465-1ec9-4c21-bfbd-54bf11c3d497",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "04a5fcee-f6b0-498e-8ddc-f794daa643f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e85173d7-4d0f-45b0-888b-73121f20ce0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d140c45d-de90-4880-9318-53f3ed406e16",
"db_currency_id": "8b4b58cf-425c-4881-ac98-42a8c71e7fcf",
"db_language_id": "e696356d-4a6c-4230-8100-48afa9a8d24c",
"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-07-04T03:56:44.8625385+00:00"
},
"modified_dateutc": "2025-07-04T03:56:44.8625385+00:00"
},
"marketing_segment_id": "d4b4f4e5-ebcb-41f9-9ab2-a401c73fb924",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "591a5fc0-d4b3-4d4c-aa8a-8655c8b3f9d6",
"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": "95f17400-244f-4ea8-ab02-169f7713a802",
"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": "5f7e3ffa-d584-44ae-9928-ef9955b76f3e",
"db_country_code": "sample string 28",
"feelist_id": "4292c33f-7765-4c82-937d-9f1c58af1cf6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "001deb30-0c1f-44d0-9bd0-d3d91c483c1c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "99f138a4-a42f-4960-9551-882590c825ab",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-04T03:56:44.8625385+00:00",
"db_currency_id": "ced739c4-d159-4917-bf31-bc580a05bea9",
"db_currency_code": "sample string 10"
},
"company_type_id": "16b530ae-a734-451a-926d-6b49bf9f44ce",
"company_type_name": "sample string 32",
"company_type": {
"id": "fc552c66-24aa-4238-b940-0d6ef58b1311",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0195104f-41ac-44de-84e3-88ba3b57efdd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "081f7a4b-8d65-4412-aebd-b2849e6f3703",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "beb8453c-ea05-42fa-9172-82d85b76a97a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "78b52c9a-30d6-496d-9209-c911c271522a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d20fbc4f-6a2c-422c-97be-bcafe6e4f9fc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-04T03:56:44.8625385+00:00"
},
"company_sector_id": "d05ff8f9-d4a1-4acd-bd02-261973340391",
"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": "c9d96c23-87a6-4e77-b834-b2f25524eff9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9ac9d33c-b53c-4de7-a28b-b9ef494cdc0c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "72554ecd-944a-45f7-8389-b79a3326594e",
"account_manager_user_code": "sample string 56",
"company_status_id": "462550ab-619e-4dac-b79f-736f5a4e760f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-04T03:56:44.8782084+00:00",
"id2": 60
},
"db_language_id": "5115d4a5-197e-417d-9a95-c3df19242377",
"db_language_code": "sample string 7",
"db_title_id": "a6f8c2dc-25d0-407f-b950-067575681780",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-04T03:56:44.8782084+00:00",
"create_date": "2025-07-04T03:56:44.8782084+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-07-04T03:56:44.8782084+00:00"
}