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": "9dee99b5-01e9-4548-b65f-e822aee17a0c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "53feba7b-4de6-4004-98ce-46fbe8f32f72",
"company_code": "sample string 5",
"company": {
"id": "642eff85-96e7-4663-9875-7bb4244275b3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-14T06:01:41.4101026+00:00",
"sales_territory_id": "43318ace-2d0c-4b9b-a0d8-f0057d8571c5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7e3cb43a-cea8-4e82-9a50-d47c7b6c3e1b",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3d49865a-4ca1-4078-98ff-0acd221bd1c7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aa4d09b5-715e-46b0-9068-9ba0f937d172",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d7890854-fec2-4a7d-a022-114e8a1788d1",
"db_currency_id": "bfb1ea5f-2751-4e17-93bd-4bb2cd4f0db9",
"db_language_id": "ffdb0d7b-ec2e-43a7-a33e-9511ec3438d2",
"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-14T06:01:41.4257268+00:00"
},
"modified_dateutc": "2025-12-14T06:01:41.4257268+00:00"
},
"marketing_segment_id": "17a543ec-0d9b-4293-8178-31f74aa41f69",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "651da405-2093-44c5-b59a-3a5dc776ba07",
"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": "95da568e-3547-46c3-84a6-a42c6c3de1fb",
"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": "58c21fd9-c5ab-4b33-885e-e7d31cb7fb91",
"db_country_code": "sample string 28",
"feelist_id": "846ea6cc-083c-457f-8d31-e0cb7ea77cfc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e4e1733f-2448-433c-afb9-26e9583cfd69",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5133a99d-8a92-4ba7-aeed-1f1631011e6c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-14T06:01:41.4257268+00:00",
"db_currency_id": "6d9cddfa-dfc3-48a6-8f81-16feb2771555",
"db_currency_code": "sample string 10"
},
"company_type_id": "27809de7-5d4d-4815-ae09-a55b70d1d8a8",
"company_type_name": "sample string 32",
"company_type": {
"id": "fd85b3e0-4aa5-4a2a-8b95-14d7a7f60d8a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f2f311a-e82b-4392-9f59-878edaa8994a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4f6b033c-eb69-4cc3-ba1f-144efa6d0184",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3568a5ab-3b8c-4610-8888-98528540c701",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "adffc092-dcf5-4fed-a661-4a4548ef2b57",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9870ef2b-4770-40fd-bc20-a045ce58a567",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-14T06:01:41.4257268+00:00"
},
"company_sector_id": "fc4c593f-72a6-453f-9390-d64887ec7102",
"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": "2a9bb233-a394-4045-936e-fcf7f455eaf7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "86cead7e-9653-412b-b87a-5dc9f248687a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d9af6cf9-3339-4501-92c7-775edabbdd2c",
"account_manager_user_code": "sample string 56",
"company_status_id": "e4cbe6ea-14a9-45c9-a5e4-4c648e1236dd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-14T06:01:41.4257268+00:00",
"id2": 60
},
"db_language_id": "81afebee-b3d3-4802-b8aa-9bb99e0a7898",
"db_language_code": "sample string 7",
"db_title_id": "e723bb34-3670-400f-8a30-aaeb15f4e139",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-14T06:01:41.4257268+00:00",
"create_date": "2025-12-14T06:01:41.4257268+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-14T06:01:41.4257268+00:00"
}