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": "dcc08b1e-56dd-48f1-b960-c44a7074deba",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "80a97bcb-a463-4b0a-a787-b030bec38144",
"company_code": "sample string 5",
"company": {
"id": "59e394a9-c118-4254-8c5d-d0aa7c482852",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-27T03:36:18.3937933+00:00",
"sales_territory_id": "4db1a863-7343-4894-85b9-387657854fe7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "cc3d7b54-302c-446f-b138-fc54251c6242",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "90d4f544-aa39-4995-b221-24dadbd71276",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d5a1a3d4-b2cb-4c4d-9c3f-d0b49824413e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbbf6d50-6ab9-44f4-b60a-3b65ef44bcb4",
"db_currency_id": "33db7f41-4ad2-44b1-8743-060a33a7be3b",
"db_language_id": "cc681593-1620-4160-abd2-8ad314b69ebd",
"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-01-27T03:36:18.3937933+00:00"
},
"modified_dateutc": "2026-01-27T03:36:18.3937933+00:00"
},
"marketing_segment_id": "f2a6f140-5851-4aeb-a281-99a1645120a1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ebe2126c-70e3-43db-984d-4ffa2a3ae8b4",
"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": "6fdb5e97-6075-4402-834c-fa1af085db45",
"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": "7da36565-f43e-427e-900d-f285705559b9",
"db_country_code": "sample string 28",
"feelist_id": "2075f6c8-054d-43e6-b898-ef3b53b2d545",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f70aec1f-530a-4f28-bae7-6a880e0d179d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "408b91bf-5ed0-4e5e-8c7e-9ff5fc0e63d4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-27T03:36:18.3937933+00:00",
"db_currency_id": "deb02a93-268c-4e2c-8d03-c9a590c1f704",
"db_currency_code": "sample string 10"
},
"company_type_id": "3313630d-24e3-4961-bbcc-398d5414eece",
"company_type_name": "sample string 32",
"company_type": {
"id": "1b3500a7-1e7b-47f5-877d-1214b9edafb1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df35cd57-df20-4467-97c5-387bccc2541f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aea1b3b9-4f78-443b-b43d-6ead2d0427a8",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "39befedf-c615-4dce-8001-8e42d6c8d2f8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9760ead7-82c6-4da9-a2dc-454ec4c11158",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9da37af9-452f-4dc2-bac7-72c9ba25f270",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-27T03:36:18.3937933+00:00"
},
"company_sector_id": "be78d67b-9163-4b3f-8cd9-f56bf7eedf31",
"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": "5acfa5a6-f21a-41fb-952f-c9b9dd1df195",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "98561ba5-8ad3-4089-8157-2c637ffd26b4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "7534891c-17d5-4deb-88c9-1ef60940d7a5",
"account_manager_user_code": "sample string 56",
"company_status_id": "a62536c1-50bf-41e1-b3b6-12265c47c408",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-27T03:36:18.3937933+00:00",
"id2": 60
},
"db_language_id": "f9797318-deec-4fc9-962d-8b0db68f7352",
"db_language_code": "sample string 7",
"db_title_id": "1555a4d8-f5e1-49f8-aef8-6fe4b875ce8f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-27T03:36:18.4091721+00:00",
"create_date": "2026-01-27T03:36:18.4091721+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-01-27T03:36:18.4091721+00:00"
}