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": "adc8f111-ad26-42c5-9de7-af700c52cede",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "899d2226-e3a0-4869-a999-070d76edf681",
"company_code": "sample string 5",
"company": {
"id": "6b3eef72-4c7e-49b4-8780-c6dfb3e83fd0",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-05T13:51:15.2494492+00:00",
"sales_territory_id": "d65acac7-861c-448c-9b55-b5af924bcf84",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "75c87c19-61d0-4b43-879e-9879ba140d51",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bcd9751e-9f1e-40ce-9e9f-7d90dc735ff7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "079c2554-bd1d-4a79-b570-fae1de6ca8d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30938fcd-335a-4ef1-855a-5f2228278769",
"db_currency_id": "bfad9655-b73c-4afe-8028-07a0f9695313",
"db_language_id": "77c32d15-dc9d-4e0a-b7cc-288507561066",
"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-02-05T13:51:15.2494492+00:00"
},
"modified_dateutc": "2026-02-05T13:51:15.2494492+00:00"
},
"marketing_segment_id": "13506468-5f94-4611-a8c7-065b539eb8c9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c5f7fc47-3720-44e3-baa7-26573d100dc0",
"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": "4c8b2466-f8db-45d4-8594-97c4a30211d3",
"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": "70e82f7d-7f88-4e4d-8683-f8d05f932586",
"db_country_code": "sample string 28",
"feelist_id": "ad220e52-a7aa-495b-9c98-3374b077ae09",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fa48c20c-4a8f-43b5-9b96-308c0d76d40b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a09c8623-654c-48b4-8c95-12bcc1d93f15",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-05T13:51:15.265072+00:00",
"db_currency_id": "668f1dd6-ec38-4863-86b3-bc2ce580d720",
"db_currency_code": "sample string 10"
},
"company_type_id": "6db05252-1d0e-4fc6-a2d3-05cfc325de6a",
"company_type_name": "sample string 32",
"company_type": {
"id": "e8ed555c-6873-4792-8560-d71bf99f5ad9",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5d6ce9cf-0069-4e21-aa70-4a1a7a1fb29b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6c5137f2-4712-4653-834b-d715d96362a5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "41dddda6-fc3b-4a26-b1c2-79b8f8ae88a6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "423f290f-1864-4074-938e-7eaecaf6e7a5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3fe36453-35a9-43c4-9c89-778dcf6aca3d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-05T13:51:15.265072+00:00"
},
"company_sector_id": "5d2b68f1-86d5-4f95-babc-6e20f9432399",
"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": "e0e83387-2cf2-4385-ba01-e1ffcdd6aa71",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cd0d4664-3ec2-4d40-ad38-93d53efc729b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c57e561e-97ee-4f59-ab01-04ec1bb4a858",
"account_manager_user_code": "sample string 56",
"company_status_id": "41af445e-6080-4719-8c8d-cda25428d755",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-05T13:51:15.265072+00:00",
"id2": 60
},
"db_language_id": "8b7707f7-cac6-4737-9b08-4d151c0b4814",
"db_language_code": "sample string 7",
"db_title_id": "c23b8ace-4dbb-4b11-91d4-d0b7a01903b5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-05T13:51:15.265072+00:00",
"create_date": "2026-02-05T13:51:15.265072+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-02-05T13:51:15.265072+00:00"
}