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": "db773fb1-2d46-4fed-836d-59339be34b56",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "9a9f5b37-4d46-4acb-9713-8060d33444a0",
"company_code": "sample string 5",
"company": {
"id": "afb241a1-4ae9-4796-9986-43147dd238dd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-02T19:36:53.9554865+00:00",
"sales_territory_id": "31cc869e-101a-405d-bfe2-c298e9f34438",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a9dfd7c3-f5cc-4d53-abd1-f81a41704101",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "42f6b9c0-d990-4271-8527-5fada379f8e6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7aafe4d7-94cb-4fb2-a63c-b07e0c222baa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4735bc09-6e48-4a3f-8999-8bc432cfcebb",
"db_currency_id": "14481618-e57f-410b-b97b-b2e12c8254db",
"db_language_id": "cbd33958-ca7e-4b0c-a019-622d6f6f19e2",
"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-02T19:36:53.9554865+00:00"
},
"modified_dateutc": "2025-10-02T19:36:53.9554865+00:00"
},
"marketing_segment_id": "19aeba95-7c9c-4d1a-ac6c-92fe4cc2b07d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8eebfb95-eeed-49f7-a2fa-257cc305534f",
"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": "bf3ebd7f-6f0b-4707-813e-fa41e38f68ef",
"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": "9d29df40-398b-400f-bea1-d24886713971",
"db_country_code": "sample string 28",
"feelist_id": "2f234180-4365-4ab4-8bca-fb563c7a8354",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0dc1a940-a534-4209-b793-f13b602105ff",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c984b822-695f-4e65-9798-f08bbf38ce44",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-02T19:36:53.9554865+00:00",
"db_currency_id": "9c48c990-94d0-4759-a1b6-032147fec6e6",
"db_currency_code": "sample string 10"
},
"company_type_id": "fc13fa25-d7fc-4f3b-ad03-9414b617dbda",
"company_type_name": "sample string 32",
"company_type": {
"id": "aea4be60-3b36-4842-a60a-82037be5ea43",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "36388196-5e85-44ec-a818-00bb61e40ce4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "631def65-ed36-48e0-96db-39f8d7f295a7",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "46d40a2c-9824-442c-ab50-c4bc90524134",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d43f0cab-9dd9-4dcc-bcad-0ad6cd044aaf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "83673244-058b-40cf-8615-6d52f35ededa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-02T19:36:53.9554865+00:00"
},
"company_sector_id": "468a0436-10a4-429f-855f-94cfd8d0039c",
"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": "fc89d31a-30b0-4e55-98e1-c8d9d87cd5de",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "339d8e75-73ee-4d82-bd2a-7f26b7eec568",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a41fffc8-e09b-4a98-a677-6e018deca03c",
"account_manager_user_code": "sample string 56",
"company_status_id": "748ad736-e24f-4988-8b70-a0de36113bc3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-02T19:36:53.9554865+00:00",
"id2": 60
},
"db_language_id": "5e6e9912-7a1b-4d8c-92b4-2a69d3f30600",
"db_language_code": "sample string 7",
"db_title_id": "9dfa70e1-470c-4195-be86-698696a1081e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-02T19:36:53.9554865+00:00",
"create_date": "2025-10-02T19:36:53.9554865+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-02T19:36:53.9554865+00:00"
}