Retrieves all the company contact
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": "f3724e95-54b9-49ed-9a49-126ee1b69df8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "937de6bc-9bcf-4a98-aff1-d13ec5f426f2",
"company_code": "sample string 5",
"company": {
"id": "452308e1-fb1c-43b1-884e-852fe3a10608",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-03T01:19:57.6409934+00:00",
"sales_territory_id": "6750c0ba-6eb9-4808-9aa4-ab9e6e323cdc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3ea402c1-5bcd-4848-a1eb-e3a417df618b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3619a31b-2104-40dc-aa61-478dba199e2f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "660861ec-fb74-4065-b947-bad2790d651a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "106181b6-5bd3-49a1-9775-df6f97164ea4",
"db_currency_id": "dc25408c-d064-4fa8-863a-c89c2a8e7768",
"db_language_id": "1ee4da4d-9955-4496-b0bd-1af85589cded",
"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-03T01:19:57.6409934+00:00"
},
"modified_dateutc": "2025-12-03T01:19:57.6409934+00:00"
},
"marketing_segment_id": "cdc4724a-3958-4786-86c0-4e347b6fe3c3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a7c8951e-8a2d-4806-8372-ae62cd9f835d",
"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": "e81fb739-94b8-410e-bf19-8cc42ad9c410",
"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": "4f4f0e7c-5660-404f-b83a-38f887d7b38d",
"db_country_code": "sample string 28",
"feelist_id": "fbcbb0e5-91b1-446e-9277-71e4bf611d65",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "20eea3ee-b687-48fa-9bb3-40549a65d1f5",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "61cd703c-251d-4657-889c-51c5446ccdd7",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-03T01:19:57.6409934+00:00",
"db_currency_id": "7b63f9b6-8182-4dd8-a9e5-dd9e57369de7",
"db_currency_code": "sample string 10"
},
"company_type_id": "506f0e42-dd55-4ddb-90be-31b1c557ec9b",
"company_type_name": "sample string 32",
"company_type": {
"id": "ff35ed73-9f6c-4ff2-b5d4-77c187b0b0e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7734d7b9-dd71-4f8a-9dc5-a966f342449b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5ac06649-7286-4e37-9989-ba3a77bc6283",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6b2e21b8-5314-432a-b814-21ff901ddc8b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "df1f6362-78a1-4de8-907e-56c28d6fd236",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b3c862e7-2b96-4ea6-9e5f-c0d1e7aa6851",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-03T01:19:57.6409934+00:00"
},
"company_sector_id": "b055edff-cd83-46a3-9c18-a5b05a65ae41",
"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": "a14dc444-72ec-49b7-a72e-aa2568ffcc4d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2cc7a433-9447-428f-8f6e-a16c4df13988",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "35ec5bdb-8a36-4c47-8e9a-7c49168ad9f1",
"account_manager_user_code": "sample string 56",
"company_status_id": "ac09a83b-9b43-472a-bf5d-47ed7cfc7867",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-03T01:19:57.6409934+00:00",
"id2": 60
},
"db_language_id": "7da3875e-2d78-41e5-bcaf-eec1540413ed",
"db_language_code": "sample string 7",
"db_title_id": "bc39036f-16c2-407a-a8ab-1af46f9256b2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-03T01:19:57.6409934+00:00",
"create_date": "2025-12-03T01:19:57.6409934+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-03T01:19:57.6409934+00:00"
}