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": "d59a60d3-7b48-439b-ad2a-70ca3faf46bd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3bfadada-fc36-422f-a098-dc6a23c6ffd2",
"company_code": "sample string 5",
"company": {
"id": "1931c7d8-7c78-4aa3-914a-bca306e7ff6d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-07T21:20:12.3418452+00:00",
"sales_territory_id": "6baf6498-0f7f-4f4c-94f8-a89728ef118b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9bcc5af2-2791-427b-b9e1-186c110269e5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c391eedd-916a-4502-8299-ee3f69d50358",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bebda5f6-b7a5-433f-ad18-9217cc07d372",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d755482-2756-4da9-8abe-9751f12a9228",
"db_currency_id": "3a6332f0-d9ad-4b55-8923-1474643723c3",
"db_language_id": "25eee008-5582-4f48-bb1c-b58fd784baf4",
"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-07T21:20:12.3418452+00:00"
},
"modified_dateutc": "2026-01-07T21:20:12.3418452+00:00"
},
"marketing_segment_id": "f16f2e4f-88de-4d69-bd3a-8ffbf76ef068",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e45c37a3-fc8c-43f4-be1d-275e5ebe3932",
"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": "a4792e07-b9d5-460c-8e9d-0fa59fff3da4",
"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": "816982f7-4f99-4988-bbe6-a653d0180944",
"db_country_code": "sample string 28",
"feelist_id": "5abd94e4-7609-44f3-ad7e-07be920bf85c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6f74dab0-e917-4208-95db-6bf16408dd40",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e2fda9bf-21e0-4948-8bbc-f58a2b841d0c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-07T21:20:12.3418452+00:00",
"db_currency_id": "3d52e653-0271-499f-b388-b500f99c1e97",
"db_currency_code": "sample string 10"
},
"company_type_id": "410af841-022b-4490-8abc-99dcc22fac75",
"company_type_name": "sample string 32",
"company_type": {
"id": "c858539c-5c4a-4e3b-ac73-b3b492185a8a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eef19750-e53a-437d-a517-75e262194753",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e7284ed9-0f24-4367-af18-b3c61e78620f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1f40a2c5-a8b7-470b-a40a-0249f3487948",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "86fc4c52-49e7-4a7f-94c1-a2ef6f83936b",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "978a1f29-b5bc-4e7a-b637-7d42030f2b86",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-07T21:20:12.3418452+00:00"
},
"company_sector_id": "7586804c-fb60-4617-86f4-0f85e722ce9b",
"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": "2eb5d58b-bc5c-4905-bef5-4bad3e49c194",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1816181b-8751-4d1c-8941-7f1afce3acc0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3ffdea6a-84a0-414e-9aff-8309716cacae",
"account_manager_user_code": "sample string 56",
"company_status_id": "a971d995-8a72-4962-b95e-64cf5d9715ea",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-07T21:20:12.3418452+00:00",
"id2": 60
},
"db_language_id": "bb9d3369-c05c-47e2-ab6d-eecd8b8316fb",
"db_language_code": "sample string 7",
"db_title_id": "f77372f6-ef00-4a92-9d7f-229afda7d434",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-07T21:20:12.3418452+00:00",
"create_date": "2026-01-07T21:20:12.3418452+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-07T21:20:12.3418452+00:00"
}