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": "231a25c8-34c3-434c-a09b-6451acc01523",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "83a4d11b-3cba-45e9-8c7c-6bdda341a292",
"company_code": "sample string 5",
"company": {
"id": "df7f0be0-db63-4286-8fc0-4b28571395c2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-24T22:57:19.2187704+00:00",
"sales_territory_id": "65f33f7a-535e-436a-82f7-dd5c04137537",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "68899fc0-07a6-47bf-84bf-5448baaf551c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "00344f88-acd6-41b4-a4fa-5df86e7748a0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "96f6be6c-3eff-4bd4-8eaa-627461233cf3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9aacd0ad-ce0d-4b7a-affc-5e65248af49c",
"db_currency_id": "e3875f49-2209-4027-89f7-ca2ad614f002",
"db_language_id": "005ee8f3-3b43-4cd2-8727-0a5a028dcf3a",
"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-11-24T22:57:19.2187704+00:00"
},
"modified_dateutc": "2025-11-24T22:57:19.2187704+00:00"
},
"marketing_segment_id": "e30af761-407f-4e7a-bcca-8e65155b6e89",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e0587818-2ba1-4dbe-889c-80f778bbd3cc",
"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": "812bedd6-a5dc-4fcf-a2f6-0630e544b6ce",
"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": "169b22cd-c8a4-46be-86db-8df4972210d9",
"db_country_code": "sample string 28",
"feelist_id": "69c4b090-e842-49db-b1ed-94754f323281",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e0176f29-e20b-412d-b38f-c4416dc24aa8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7ca9a602-aebd-4c5c-bea0-7c9532209ee0",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-24T22:57:19.2343947+00:00",
"db_currency_id": "0d464789-d3d8-4491-ae3f-9df0b3f47b26",
"db_currency_code": "sample string 10"
},
"company_type_id": "932d25a1-462e-4df6-a6bf-106fb86ed253",
"company_type_name": "sample string 32",
"company_type": {
"id": "5be4e3ff-0a60-4d88-978c-6d1556b795de",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "606f2dc6-87db-426c-b073-becaffa41068",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b6be116a-d34b-478f-a128-00e5fd58ebd4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2d078c82-c234-487c-acaa-060a8d2a7f53",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "f2c96c7c-d9ac-4fd1-b206-f0f6b0624dd5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c7c173c4-38ac-4d1e-96e8-6ab1cf16cefc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-24T22:57:19.2343947+00:00"
},
"company_sector_id": "5b2cc80d-e6b4-4df0-9300-708fca1747ed",
"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": "840869ac-be28-4081-a31a-9baf9744a755",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d99a904e-495d-4e1f-8cfc-50ae06d98aea",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "3e3355ff-ea62-43ab-bec1-846da0dec75c",
"account_manager_user_code": "sample string 56",
"company_status_id": "9db3b36d-d433-468a-9f75-012839464c74",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-24T22:57:19.2343947+00:00",
"id2": 60
},
"db_language_id": "aea7d53c-bdac-46f5-9eff-3095a25ddfad",
"db_language_code": "sample string 7",
"db_title_id": "421d06f6-7f25-4fa0-a818-c402fe1b2ae6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-24T22:57:19.2343947+00:00",
"create_date": "2025-11-24T22:57:19.2343947+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-11-24T22:57:19.2343947+00:00"
}