Get Contact by Company Id
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| company_id | string |
Required |
Body Parameters :
None.
Response Information
Resource Description :
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": "76b2ad95-5d18-4162-a7ed-2aa7764dc01d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cec233ed-f126-4665-8fa0-9f67fa778974",
"company_code": "sample string 5",
"company": {
"id": "3aa37d3f-2c1d-4087-aab9-876fda51ca6c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-02T21:38:35.2087584+00:00",
"sales_territory_id": "84a75a97-e25b-4efb-8e3a-de7d649b2053",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "83559447-c8e6-4013-8996-78f16f7034f8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2f391335-43dc-4d35-820c-b7d2f345aca6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a360b645-3cbc-4924-be96-18d2c5a524ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c44a1a0b-9302-44da-8d4e-a7e7a00f00b4",
"db_currency_id": "e6a9e5ec-5c68-4902-bf2f-cfce64bee797",
"db_language_id": "085af1d8-5202-4d13-81eb-a18f0df5efa3",
"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-10-02T21:38:35.2087584+00:00"
},
"modified_dateutc": "2025-10-02T21:38:35.2087584+00:00"
},
"marketing_segment_id": "6ffca9bf-42af-43d3-9cb9-bee47c212a48",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3fcaed4e-ef14-4c74-a3d0-11fef2d457bb",
"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": "4e7f6e3c-fd79-4c34-905f-5202c790d881",
"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": "f809d788-65d0-4542-a975-f398145d780c",
"db_country_code": "sample string 28",
"feelist_id": "98bd83f8-192c-451e-8f93-b15e631ac3e2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "65d7f8fb-9edf-456a-8107-130c24bad6f0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "1105e364-f0e3-461e-8ae1-fd0734666ff6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-02T21:38:35.2087584+00:00",
"db_currency_id": "8879bb8e-edde-44d1-802d-0e18dd114a24",
"db_currency_code": "sample string 10"
},
"company_type_id": "7cb3946e-6634-4d66-8bbe-1ee22eb42fed",
"company_type_name": "sample string 32",
"company_type": {
"id": "b332fd9d-4c71-4753-a375-bbd0d53a142b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "66a5c839-1b8b-46c5-b098-1ba14c53f722",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d7446c4d-9577-4415-b239-100b5394cd39",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0aea6dd1-fced-475e-be80-6b74e874c449",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "50cf8809-761b-4b22-ac22-6ecb3b6e211a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1aade3b4-8fcb-4fa6-b6f5-5b2fc3cdf2f4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-02T21:38:35.2087584+00:00"
},
"company_sector_id": "d3e01232-051c-4b08-a70f-228a62248927",
"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": "71ce7042-ce89-47c7-8dbc-78f007182e30",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bb2131f1-6977-4212-987c-47e0bf6b6932",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8eacd909-37ca-4d21-a619-ddf2b0c21add",
"account_manager_user_code": "sample string 56",
"company_status_id": "f42a005d-d04b-4ed2-91ac-a615fa5e3635",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-02T21:38:35.2087584+00:00",
"id2": 60
},
"db_language_id": "51460815-ee46-4f1e-892e-b6615be3b474",
"db_language_code": "sample string 7",
"db_title_id": "c17f24e9-4549-4efc-8cb2-f9a59b608514",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-02T21:38:35.2087584+00:00",
"create_date": "2025-10-02T21:38:35.2087584+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-10-02T21:38:35.2087584+00:00"
}