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": "b16e1fc1-045e-44d9-a1f3-dd46d6389a87",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2c46345e-7765-4e5d-ba11-e3ba02bf9abe",
"company_code": "sample string 5",
"company": {
"id": "458a2540-3bfa-47a5-bc29-f9f0f5a5c37c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-12T22:16:27.8658503+00:00",
"sales_territory_id": "50248340-8942-4adb-8a4b-7f1d29669226",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1b708394-808e-4829-a326-f453fa7cb572",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2df69833-92ef-4f1e-8e8a-b9429e3212ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b865cddc-6d7a-4505-b14f-247daf1edc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b4843e30-e193-4eff-a3d9-9516b18f26a7",
"db_currency_id": "5b414114-fe23-47a6-9877-a3773fe94252",
"db_language_id": "a821a7fd-addb-432f-8238-5001f19b0596",
"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-12-12T22:16:27.8814772+00:00"
},
"modified_dateutc": "2025-12-12T22:16:27.8814772+00:00"
},
"marketing_segment_id": "0c1a4215-75c8-4d23-9d32-f947a29eddad",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "05d950db-d80b-4515-82b1-94af5ce6f8c1",
"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": "39a5ca48-8179-40f7-bee1-c5d1e5233288",
"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": "76872b72-875c-49fc-ac72-996d12b98dfe",
"db_country_code": "sample string 28",
"feelist_id": "3eaef92b-c5c5-463e-a9ae-374318c1e06c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "812e737d-87cb-4441-b9fa-09a4cfb7bbc7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b5114467-ee22-4290-98a8-783444371d24",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-12T22:16:27.8814772+00:00",
"db_currency_id": "c24f846b-65fc-479b-8241-da69308179f0",
"db_currency_code": "sample string 10"
},
"company_type_id": "9f430e00-6ea9-4f8b-91a9-7b3d611afaa3",
"company_type_name": "sample string 32",
"company_type": {
"id": "afad1b76-f8ab-4f8d-b5b2-6d378dbbc657",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0cb3c21c-65ff-40c6-b124-49177c7db8ed",
"sales_organization_code": "sample string 5"
},
"db_language_id": "10f27b8e-6e66-49cc-95c1-40200b151d14",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "40f09bba-52bd-406c-8226-d61399fb2d78",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4fe47a8e-9b45-40ac-94b1-d79e60d023b6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4a9f0037-6e59-415b-8304-371d76d88da1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-12T22:16:27.8814772+00:00"
},
"company_sector_id": "95216ace-c2a5-4f3b-adcd-c31a3ce1f772",
"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": "c66b49bf-5965-4013-be96-ba15c806e8c4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2db09ca5-3d91-4907-b8bf-90ffb800b80a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "28f12c94-f820-4888-8f98-b2871b3c288b",
"account_manager_user_code": "sample string 56",
"company_status_id": "7a771759-48f7-49e5-bb68-ca39ca900c47",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-12T22:16:27.8814772+00:00",
"id2": 60
},
"db_language_id": "d511ba92-d944-4086-8d25-513f1d9a53e1",
"db_language_code": "sample string 7",
"db_title_id": "4c5a2f8d-af5c-426a-b3c4-efbdb97e9da2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-12T22:16:27.8814772+00:00",
"create_date": "2025-12-12T22:16:27.8814772+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-12-12T22:16:27.8814772+00:00"
}