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": "2906d184-49f8-4604-b8db-39a85895fe9b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "5948044f-b285-4715-9cc0-6b77a0219867",
"company_code": "sample string 5",
"company": {
"id": "cb93b088-ee09-4c57-9b1a-01dfd5fca7bd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-25T04:55:54.8976887+00:00",
"sales_territory_id": "ed62ab41-7cb0-4cef-bff1-cb06c88d9811",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b6eccb4a-139b-49f8-90a1-863c0a0ac065",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ed4d37fa-d9d6-40cc-af53-9aed0325a73b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "61aef2c2-0eb9-48d5-b43f-151b51be89b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b090f10-0bf8-4878-b084-e7670e3c0b79",
"db_currency_id": "2f14ea3d-c611-4b95-b2eb-4957205c4593",
"db_language_id": "4dfc24b8-9d4e-4135-bc4a-ff4b7449b6d5",
"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-04-25T04:55:54.8976887+00:00"
},
"modified_dateutc": "2025-04-25T04:55:54.8976887+00:00"
},
"marketing_segment_id": "76bdee2b-6d48-457c-aaa3-24e01f5c07b7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c9023d62-5e31-4a93-9066-ceb386e613e9",
"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": "6b7089ee-1440-4c66-a995-e85b85396eeb",
"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": "0f995333-aa14-49b6-941e-ce28f3f60f97",
"db_country_code": "sample string 28",
"feelist_id": "db1032eb-acc8-4cbf-adae-9086fb2edfdf",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0ac4d98c-6678-4e02-8063-9755643a2d7c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "73d20522-e47d-49bc-9d5b-3eeffd4300c3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-25T04:55:54.8976887+00:00",
"db_currency_id": "a1929a42-f009-4afa-93d1-2d1643cbc587",
"db_currency_code": "sample string 10"
},
"company_type_id": "e06f2169-76fa-4e29-bdac-ac7215cfa41a",
"company_type_name": "sample string 32",
"company_type": {
"id": "29127dbc-5541-4412-b105-71ba21b10442",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6791eae4-2d8a-4421-a029-32fedac296be",
"sales_organization_code": "sample string 5"
},
"db_language_id": "7deadf5e-9063-4df4-bae5-437eca1aebfa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d352971c-4a7d-4905-87c6-0bfd31984e1d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ca314f00-d8ac-4687-bc7f-3b0828ecfcc3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1d66350e-9d12-4c8c-9bef-23306762b011",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-25T04:55:54.8976887+00:00"
},
"company_sector_id": "1226e9d5-40b6-4a26-a297-ae1ec6ef8efa",
"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": "4207b14e-98fa-4dde-be42-2582563f1219",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2e3b223d-f9ae-4073-87d2-56975e75df81",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "15b36201-07c9-4b3d-9d0a-b3e06fed25e9",
"account_manager_user_code": "sample string 56",
"company_status_id": "0d936db1-08d0-4d8f-863d-995ee34fe47f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-25T04:55:54.8976887+00:00",
"id2": 60
},
"db_language_id": "d173db32-c046-406f-b4d2-4fc23e03d88f",
"db_language_code": "sample string 7",
"db_title_id": "3cab2562-7a1e-4127-ae02-74c800a784b4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-25T04:55:54.8976887+00:00",
"create_date": "2025-04-25T04:55:54.8976887+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-04-25T04:55:54.8976887+00:00"
}