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": "2d2a450a-64b3-4160-b262-7c575297dba3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "24a61618-6094-4188-8280-215814701941",
"company_code": "sample string 5",
"company": {
"id": "389dd85d-a485-462f-b283-89cc946a2715",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-22T01:11:47.9193615+00:00",
"sales_territory_id": "70cc3ac3-6a4e-4083-9466-6b9d2e246056",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e33b4298-55c7-41a1-a2fd-239fdaa414fc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "afaa0f53-d916-4701-a677-6ebdb1917580",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5306067b-6772-497b-9726-757497544edd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5b431727-9ce9-40a4-8178-6113532a5c3d",
"db_currency_id": "f6a9b458-8bff-4909-8d6d-cc1a8ea7e61f",
"db_language_id": "a1f08a1e-694c-471f-a2e8-1bcc546c2a42",
"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-01-22T01:11:47.9193615+00:00"
},
"modified_dateutc": "2025-01-22T01:11:47.9193615+00:00"
},
"marketing_segment_id": "f5072e81-c159-4797-a196-950856aff286",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "badcc8a7-9049-432a-bd30-78a08d640e6f",
"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": "708857f6-1a3c-4a8d-a354-f3b2df234355",
"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": "76161980-ca8f-4de6-a797-d3cac002ace8",
"db_country_code": "sample string 28",
"feelist_id": "df2cd2cb-02ae-4467-a9a4-3fecd646ea9a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d4645961-4afe-408b-9170-e108f88441c8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "82426f5d-deea-4d47-840f-011eee4976b9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-22T01:11:47.9193615+00:00",
"db_currency_id": "6d34ef95-2ef9-464b-adba-15c0de5d67fa",
"db_currency_code": "sample string 10"
},
"company_type_id": "765b4bbc-4fac-4f1d-9416-018c9bbbdf2a",
"company_type_name": "sample string 32",
"company_type": {
"id": "70c1faa6-198d-4616-b9c2-078fa76bf377",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "440cdada-509c-47f1-9c49-20d8ede5a6fc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "44a03f5c-0187-44ce-b2d8-5489da4a96d9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "115e4a8e-1267-48e6-83b4-51eb5cda81dd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4eb2b7e6-c91b-4ca2-8eba-bb67c9f94e15",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bb0f6069-a096-4dc0-90e9-e33b43d37432",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-22T01:11:47.9193615+00:00"
},
"company_sector_id": "4b8cdead-3102-4c7f-87f0-ab4b52415635",
"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": "866eb0b2-ff60-4b31-8ca8-1ba7b717ef90",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8deaa262-1015-49da-8b51-cc67b280fa2f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "36f3799a-286c-4f5b-8dee-757f2681b623",
"account_manager_user_code": "sample string 56",
"company_status_id": "d58b6e44-8637-40ad-a5eb-2b1df012b69d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-22T01:11:47.9193615+00:00",
"id2": 60
},
"db_language_id": "90e02a27-24e2-4b04-854b-c7e1d356e5d3",
"db_language_code": "sample string 7",
"db_title_id": "383f14fb-9597-42b6-af5c-fe2b56915f9c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-22T01:11:47.9193615+00:00",
"create_date": "2025-01-22T01:11:47.9193615+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-01-22T01:11:47.9193615+00:00"
}