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": "ea783250-48dc-4696-a146-8f64bd7cd949",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f1e21ed6-e8b5-46b2-bd7e-d10b7a79e7c5",
"company_code": "sample string 5",
"company": {
"id": "f0ed0bc7-d705-44c2-81b0-9a087bf20088",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-18T19:42:22.0120025+00:00",
"sales_territory_id": "aa327a9a-aa37-4597-bf52-9b88e76f1fd8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "faf998b7-3a4e-4aec-ae03-d17716cc893a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "01c54769-ab60-4b12-a502-5cb9cd0efd34",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a137a433-4724-4ca3-bf80-17284733d516",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3aaf7214-702a-4af5-a188-fb4640ceebf0",
"db_currency_id": "367016bd-5407-4e29-b496-49682440f463",
"db_language_id": "da059f28-69f6-42ad-8735-7b99db1c99c5",
"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-18T19:42:22.0120025+00:00"
},
"modified_dateutc": "2026-04-18T19:42:22.0120025+00:00"
},
"marketing_segment_id": "eae9055a-e41e-4bae-ba01-ed225dd5b5b1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a6834119-3bba-4cfd-b856-8a3e9332ac9e",
"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": "9896cf60-e19d-486e-a1ae-ad1a8eb010d8",
"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": "b3d2bb8d-4549-47b5-811b-63747507e0e6",
"db_country_code": "sample string 28",
"feelist_id": "d4bc379a-edbe-48e3-bc62-c46e87983544",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f9ca7d74-a17d-4327-9400-c01f0503db74",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ae54361d-3c96-4840-ba38-903ac6f36c92",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-18T19:42:22.0120025+00:00",
"db_currency_id": "523d5df8-d7c3-45c4-867c-359d7d25d725",
"db_currency_code": "sample string 10"
},
"company_type_id": "4da2c7d3-52e0-4cce-8d7f-902f6e07d565",
"company_type_name": "sample string 32",
"company_type": {
"id": "8f915aa7-5736-4963-a96b-bb5fba846639",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ea9162d8-9ba2-433d-83e5-96f5416dac88",
"sales_organization_code": "sample string 5"
},
"db_language_id": "06d9fc88-244a-4bd3-88bf-4c85a5c79d7f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5409faa7-b986-4286-b2d5-0e06abd75cc1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "dd463f41-8d60-42db-9a57-510736890bb1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3d5b5a67-1a34-4ba7-9574-b9546304cb16",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-18T19:42:22.0276185+00:00"
},
"company_sector_id": "2cf2a132-94bb-42f3-9f6a-ce93af846b45",
"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": "ca03b093-48ca-4d3f-ace2-e710b76e091c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "23e55051-7e97-47b7-99ee-55118d55d8e2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7f90c5c6-6270-4b42-913e-d1bfb3b72586",
"account_manager_user_code": "sample string 56",
"company_status_id": "8f6af012-5673-4eb3-9313-52e3542bd44f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-18T19:42:22.0276185+00:00",
"id2": 60
},
"db_language_id": "1afa77f4-b361-45a8-b01b-c46bf4c44068",
"db_language_code": "sample string 7",
"db_title_id": "3e47a3bd-3074-411d-bcf3-26b9ef659f76",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-18T19:42:22.0276185+00:00",
"create_date": "2026-04-18T19:42:22.0276185+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-18T19:42:22.0276185+00:00"
}