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": "2a4d9746-9b4f-458e-952d-20a37767677f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "14e9c5c0-2a6c-4d84-95a6-e20c7045ae84",
"company_code": "sample string 5",
"company": {
"id": "353a9ff4-a3b1-4962-b7ff-c05395f0c766",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-17T20:52:10.9680522+00:00",
"sales_territory_id": "a3667a8c-af84-4184-9507-92d837b58ff7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0ed6b8b7-9cc6-408e-8543-3fcc38bc3d02",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c6db0872-f6e2-414f-a760-96642460842b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0bed3217-5d7b-4a1e-acbf-2056c1b55210",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "88f30283-f5ab-429a-8475-d76318cdf246",
"db_currency_id": "d5e347c2-878d-413a-93c2-d94741313f8f",
"db_language_id": "265121e0-8562-41eb-bdd1-c5ba3c78a6de",
"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-07-17T20:52:10.9680522+00:00"
},
"modified_dateutc": "2025-07-17T20:52:10.9680522+00:00"
},
"marketing_segment_id": "9c4ebb42-d33d-4ce5-801d-9d9bbaebcffb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a405f69a-efe4-421b-8422-9f3387c546d7",
"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": "bb69fcb7-ccdd-49dc-a71c-78584d5df0ef",
"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": "6b6df989-cebb-4d0c-bd0b-c74a1650fb39",
"db_country_code": "sample string 28",
"feelist_id": "b9121d42-00d4-49af-a3cb-4291bb3c9080",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f1298ef5-d4e0-4f1d-b594-1222ead07549",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ff613728-4ecf-4de3-bff9-4daf9c3dd989",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-17T20:52:10.9680522+00:00",
"db_currency_id": "d74f67ba-2f84-4a43-b13f-95c6b2d858dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "75a70e22-2f25-40d9-a8ce-3c759e1051c9",
"company_type_name": "sample string 32",
"company_type": {
"id": "1bd0f680-f490-44a7-b630-304fc9d2c29c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "071292bf-8bfa-42ce-a114-60c7bdb084e0",
"sales_organization_code": "sample string 5"
},
"db_language_id": "da2bbbb8-25e7-4961-824a-3e141e5f8656",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "87754ec2-5d8f-46eb-8806-80da357a5f84",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0a3b26cf-7d84-43e6-a266-786ea8500fe6",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d93d64ce-f65d-44ac-a79b-173dada4ba13",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-17T20:52:10.9680522+00:00"
},
"company_sector_id": "82231f9e-34e1-4c86-a6d7-868ef1207197",
"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": "1407e1f3-6e64-416b-bb72-3d937b07b61a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0ac6ff4f-6113-45d0-9b6b-dde490de909e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c57b3426-47cd-494c-a933-b87e29c6ed9a",
"account_manager_user_code": "sample string 56",
"company_status_id": "391ed5ca-ebae-4243-8637-83867b8067fc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-17T20:52:10.9680522+00:00",
"id2": 60
},
"db_language_id": "769fbcd5-6e58-426b-a0df-d68ceaf32215",
"db_language_code": "sample string 7",
"db_title_id": "cdbbfe95-5974-4f81-a32b-5b1043e71e0e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-17T20:52:10.9680522+00:00",
"create_date": "2025-07-17T20:52:10.9680522+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-07-17T20:52:10.9680522+00:00"
}