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": "9ba64e04-2fa8-47b7-bbfd-fb4e070329ad",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3de51f2d-d138-46d2-a817-82d99a4175a9",
"company_code": "sample string 5",
"company": {
"id": "70abd433-5505-4953-b8f0-a25190b93b97",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-11T17:41:45.428979+00:00",
"sales_territory_id": "fe91730c-b7e9-45ed-9cb3-9f57ddfb8be9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d1ba2634-e263-4a7a-81ff-ed43693eb612",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1dcc1559-4335-42f1-9703-21186592d82b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e0a298f4-310e-45e8-aa07-a4c13c87a790",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b6b5192-ede7-4fe1-b5e5-2b6dd8c9cbb7",
"db_currency_id": "82116f16-058e-4e8e-b206-1e74e180bd19",
"db_language_id": "d6ee6733-bc9c-4428-a197-cb1a51a5ddb1",
"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-09-11T17:41:45.428979+00:00"
},
"modified_dateutc": "2025-09-11T17:41:45.428979+00:00"
},
"marketing_segment_id": "ea0a7fcf-9c5c-410f-bc99-6932813a63ad",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a275afd3-8e3a-49ee-846b-0ab7bc3c266f",
"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": "e5e5ab5f-062b-4853-9f5f-d4524e41bb45",
"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": "69c95312-bdd0-41d2-9b66-bbbae3d81188",
"db_country_code": "sample string 28",
"feelist_id": "7482f4d7-ebfd-4564-bfb7-a80e83188cf5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cef0bb79-d568-4911-9d52-712606b52974",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a82b4842-030c-44f0-8133-e6c5a8b578bf",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-11T17:41:45.428979+00:00",
"db_currency_id": "f320574a-caca-4b2a-8287-d703f5544cc6",
"db_currency_code": "sample string 10"
},
"company_type_id": "95abdc16-9030-430f-a260-23be3560f8a5",
"company_type_name": "sample string 32",
"company_type": {
"id": "651be86a-6f14-4496-8d46-70a64bc70c0f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d7d44619-32f7-4a1c-bea0-b5991daf6b63",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7edc74a3-773b-4ab1-8a2d-2d6862472699",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b2b45a76-e946-463b-9cc8-3a50fede6a72",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "556bb55e-6cf7-4ae2-b123-65e20d0996cb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "eb5e4367-e99e-45f8-be98-0a706b148bba",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-11T17:41:45.428979+00:00"
},
"company_sector_id": "57d54ad4-fc5c-4a7b-a05e-b9ca08f3fae2",
"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": "875ba374-516b-4343-b0a7-22a8bb3b02b8",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "86ce8a3c-ec39-4c22-9251-deb92859756f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e9e1d8e5-7f47-4535-a259-c73b9eef9878",
"account_manager_user_code": "sample string 56",
"company_status_id": "e1adcc05-ca67-4eb6-9af9-4867a9200ea9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-11T17:41:45.428979+00:00",
"id2": 60
},
"db_language_id": "aff34f19-79cb-42fe-8d34-4f6b48e6433f",
"db_language_code": "sample string 7",
"db_title_id": "722c85d4-1501-4738-9016-301ad1743ab2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-11T17:41:45.428979+00:00",
"create_date": "2025-09-11T17:41:45.428979+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-09-11T17:41:45.428979+00:00"
}