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": "e8372d8d-63d6-48ef-99c2-1d36ba4353dc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bfcb09ef-78c5-484e-a496-a5a074d96c0a",
"company_code": "sample string 5",
"company": {
"id": "755e2471-6378-46c8-bf74-eb23ff6f7f71",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T03:50:23.8492156+00:00",
"sales_territory_id": "7c8ebe75-b184-44c1-b6ba-d9a1effa52ce",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3d1fe897-7a67-408f-b540-7e3c78dff956",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "01ccbfeb-e84f-4dfb-bc76-be4abc41083c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f85abe0-6c7a-4cc8-83ae-c3a1c3455960",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5f3b31c2-b2f0-42fd-9c74-239a5e8cdf0c",
"db_currency_id": "398dc70f-9491-4ed1-924b-b2fbe949abed",
"db_language_id": "c7e903b1-d202-42fc-9dbd-0f4987c0da07",
"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": "2026-04-18T03:50:23.8492156+00:00"
},
"modified_dateutc": "2026-04-18T03:50:23.8492156+00:00"
},
"marketing_segment_id": "d71c9d5c-6cd4-4ccb-b474-2b1071fd41ef",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "92f49ccc-095d-48f9-b2c2-a9f323524c28",
"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": "5d23d3dc-6fd4-4210-93b8-61a442d886f0",
"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": "ee5ab896-ade3-4831-90a1-2f1b6cad2d90",
"db_country_code": "sample string 28",
"feelist_id": "b27e6f1c-3c25-4ee8-b984-80bf9abeaae1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "79604173-9519-41e4-a1e1-34bef0232398",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8480caad-3f31-4bff-b12a-fda4551160c2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T03:50:23.8492156+00:00",
"db_currency_id": "d2a91fd4-d53f-4b46-b8dd-77fcac65cfb2",
"db_currency_code": "sample string 10"
},
"company_type_id": "e1329207-8a87-4d7d-9226-055183640a3a",
"company_type_name": "sample string 32",
"company_type": {
"id": "b869d9e3-e07b-4d02-a67c-b5158d003626",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2df8230e-0819-45bb-b2e3-c0127683e45d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a450a678-a419-45cb-bb01-ac63d1e3f356",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "169f2c87-0f8c-49db-8ae6-08887d32f5d7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "44352091-2f20-4563-9ad6-e95f0696b9d2",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "92d2dee2-cadb-41aa-86a4-ed2ed4231108",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T03:50:23.8492156+00:00"
},
"company_sector_id": "f7445682-faa9-492a-8ef5-90c6955fea36",
"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": "f203b08d-5207-4122-abc3-af1745f0021a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4034c1db-4b81-429a-843a-337e139a5242",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "69a2ec56-93a9-480b-848a-b04d5c03d987",
"account_manager_user_code": "sample string 56",
"company_status_id": "dc202801-1152-495b-a782-8aa43f84ad3c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T03:50:23.8492156+00:00",
"id2": 60
},
"db_language_id": "ae749486-b426-4846-8334-3de8311845f9",
"db_language_code": "sample string 7",
"db_title_id": "ca3da9d1-7fad-4c1a-a2e8-6e8aec233867",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T03:50:23.8492156+00:00",
"create_date": "2026-04-18T03:50:23.8492156+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": "2026-04-18T03:50:23.8492156+00:00"
}