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": "41322a8e-c125-487b-bb6c-78d82e6b16a3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "577e20e0-cd9e-4449-9a68-7120db42383c",
"company_code": "sample string 5",
"company": {
"id": "09a50bad-3173-432f-b3df-e075215e7a2d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-31T21:22:44.7965803+00:00",
"sales_territory_id": "39cf6bc3-3764-47fc-ae70-48102747cebd",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "43d84e64-3aaf-433e-9c7b-9e466c809783",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4c658c92-a19e-4a50-b97c-2221f1d92023",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "591e2af5-97a3-4f0e-bca0-7ab1db9f8228",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d428cbad-201f-410c-a24b-2adeb4fa1321",
"db_currency_id": "5e57755c-8727-4625-9311-104ab18869e9",
"db_language_id": "832228d7-c2d7-44a1-92c4-da7a78e0428d",
"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-03-31T21:22:44.7965803+00:00"
},
"modified_dateutc": "2025-03-31T21:22:44.7965803+00:00"
},
"marketing_segment_id": "064eaf82-5e4d-49a8-b591-d59c0cae93e2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f8d1811f-8344-4030-86b9-9bfb87d95d00",
"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": "9ec16a99-69e7-400e-9bb6-ebdcea431247",
"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": "ec6229b9-048e-4025-8976-9822a4d9c2d0",
"db_country_code": "sample string 28",
"feelist_id": "2142f4ac-22c8-4dec-b807-bfae48387a6b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a0a37a4c-4ab5-4f9d-af44-d34ef6f755c9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2b7b3866-5e66-4580-9c8d-cf2b1dd3639e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-31T21:22:44.7965803+00:00",
"db_currency_id": "1e21c5fb-2892-4b2e-a895-3fabd6a65123",
"db_currency_code": "sample string 10"
},
"company_type_id": "f32a1d95-f69b-4596-a9b0-714a45aa9e2c",
"company_type_name": "sample string 32",
"company_type": {
"id": "4111e930-25bf-4739-9a36-39fe901dab1f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "016fffb1-baf6-419e-a5d1-77798af664b5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0e820e01-5eca-49dd-a2c9-e932cc17f242",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f279835e-c254-481d-9b93-60a14ff55946",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4e374c18-f3a8-4feb-99df-909585153e34",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4dadc1e1-8882-4810-98b9-1610a93263ad",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-31T21:22:44.7965803+00:00"
},
"company_sector_id": "be23b97d-8ea8-4043-a2aa-967c3f5bca38",
"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": "0bfb58fa-89f6-4084-8243-1986e4b13f34",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7799baa6-8eb1-4f05-93d6-de17ab2999e1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ff3bae98-a305-4f06-a905-8260d541022c",
"account_manager_user_code": "sample string 56",
"company_status_id": "27486369-b341-4ff9-a060-6f54ef6902a5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-31T21:22:44.7965803+00:00",
"id2": 60
},
"db_language_id": "27a68434-a640-4ad8-aaa3-c4e2902fdee0",
"db_language_code": "sample string 7",
"db_title_id": "6c77ab16-6c3d-41c0-b74c-753548dc0985",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-31T21:22:44.7965803+00:00",
"create_date": "2025-03-31T21:22:44.7965803+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-03-31T21:22:44.7965803+00:00"
}