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": "3b24a7c4-c360-4e16-a593-eedf67efaa61",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0c4ff014-718d-4144-85af-ca94aaceac6f",
"company_code": "sample string 5",
"company": {
"id": "3e4d22df-1ca6-4c21-8e45-bc5c0f5cd635",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-22T00:33:56.4252333+00:00",
"sales_territory_id": "6d7d9e06-6811-44aa-aa0b-c6c256695e41",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7c5ccfe7-108b-475f-a769-6fddf9b92c04",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "abb5e505-d1c4-4285-8086-6c95e37bffad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "07bfb267-b028-4488-8a5b-a23b8e28f487",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5dbbf4d9-7c76-4f32-bb60-1f240d5ced65",
"db_currency_id": "369b6e53-962d-4026-9795-b0f5b80eb8b3",
"db_language_id": "8525fdb2-3c18-4376-b6c7-efabdef5bdcc",
"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-22T00:33:56.4252333+00:00"
},
"modified_dateutc": "2026-01-22T00:33:56.4252333+00:00"
},
"marketing_segment_id": "55bda56e-f1f5-4ed5-a9a7-5b2e98217375",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8e4b6d2f-2d4a-45a4-a5e4-377afee53162",
"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": "67facd2e-1bdc-47b4-af95-f10037b48d0e",
"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": "b73b04a7-fd1d-42e0-99b1-c4f73704fb37",
"db_country_code": "sample string 28",
"feelist_id": "efa48ef3-3371-4b2e-850f-cea6a8b95187",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fd4b8327-e7fc-4a54-b45d-da68f128ef17",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "91533d6f-d09d-410f-9b0b-ce78b26ccd83",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-22T00:33:56.4252333+00:00",
"db_currency_id": "0481aad7-0114-4aaf-a1ea-2789056968df",
"db_currency_code": "sample string 10"
},
"company_type_id": "4d50634c-a128-48f9-ad22-83dc3bcede7e",
"company_type_name": "sample string 32",
"company_type": {
"id": "5738a6e7-af5e-4afe-9142-5d37dfec4179",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1dc58b0f-08d5-46bb-ad44-ebf7e67cbc7c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e35ac52f-7440-40d5-aa4e-fc00a4d49019",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2feeb4cc-8cd2-48d2-8e5e-052f0c6197fc",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5e13b666-49e6-4655-8e35-0ac7b7261ccb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eb404c9d-5ea9-4fdc-bf83-7f36ec795f96",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-22T00:33:56.4252333+00:00"
},
"company_sector_id": "d4473a8c-b139-4d73-ba82-9998d3c4af56",
"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": "984a4856-af46-466f-ba73-4544b730e30a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "cde82c9c-816c-4356-be0c-88b76f917b94",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "681b9d1f-bc97-462b-9b69-fa0494b3ed61",
"account_manager_user_code": "sample string 56",
"company_status_id": "d579135c-ace0-4818-8593-1d4938a0257d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-22T00:33:56.4252333+00:00",
"id2": 60
},
"db_language_id": "6ad58fe8-d9cb-4b28-8129-84483efb26b9",
"db_language_code": "sample string 7",
"db_title_id": "691e17fc-4d4d-4e8c-850e-460419351c67",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-22T00:33:56.4252333+00:00",
"create_date": "2026-01-22T00:33:56.4252333+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-22T00:33:56.4252333+00:00"
}