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": "91b8504a-61d1-4460-b90e-fd4e717c5cf3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eae79eb2-eac2-43b6-810a-52a939831bf4",
"company_code": "sample string 5",
"company": {
"id": "b0be5499-11ae-4855-93d4-50801aba7234",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-22T20:03:30.6875457+00:00",
"sales_territory_id": "3a36e824-5e72-41cf-82a6-ce4ce4bd802c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "463dd117-69b3-4caa-a1a7-c3b8dd7d4e51",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "942be158-e7cf-45da-8621-ce46dc25a997",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf74dc1d-e1dd-4bad-8938-471e724718fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c7092137-050b-4b93-b80d-3aaa14cceea0",
"db_currency_id": "daafce6b-7009-4a0f-b480-7b9fcde62165",
"db_language_id": "56026773-077c-41ab-ac59-0af6dc2136ae",
"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-10-22T20:03:30.6875457+00:00"
},
"modified_dateutc": "2025-10-22T20:03:30.6875457+00:00"
},
"marketing_segment_id": "87092a3e-5fdb-4aaa-a7ad-672b12ce865a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "40c673df-6b19-4ac7-9156-37f941fe3d42",
"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": "8b82bcd9-d9cc-4868-8f58-e299e484bf07",
"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": "de2ec6b2-a3ee-487a-b2d8-88fb04af6601",
"db_country_code": "sample string 28",
"feelist_id": "19564c72-7f06-4ae8-ab83-c2e45e5860a4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1de0ff17-877f-4be7-a432-a95130a5e22c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2fd40bf1-af4e-4fde-a631-fa6c8766ddc6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-22T20:03:30.6875457+00:00",
"db_currency_id": "9d7ca834-5f70-4ffb-bc3b-0170f2ef2b45",
"db_currency_code": "sample string 10"
},
"company_type_id": "8441bbb1-e0bd-4d1f-ba03-942f9ca3c622",
"company_type_name": "sample string 32",
"company_type": {
"id": "f1e53a79-9a88-47c1-9086-0450a1fac529",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6f2239b0-7e01-4e7b-90cb-03f7214f8002",
"sales_organization_code": "sample string 5"
},
"db_language_id": "99e294e6-d936-47db-82a1-223163d2f9dc",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "864cde8e-fa05-402c-b093-526bf3c9cda1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "71f49637-5374-4117-aaba-d712d12c932c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0789797f-9bab-4cba-93bc-a838ad915727",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-22T20:03:30.6875457+00:00"
},
"company_sector_id": "a257cc19-e65e-4a19-b4a7-7d30568aac71",
"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": "95847473-92ee-4e04-a505-bebbcba384a3",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8cb960a7-dda9-40f0-9313-54d5ed8f1a8b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fa9089c5-0a1f-4ce9-b154-1524522095c8",
"account_manager_user_code": "sample string 56",
"company_status_id": "cf58caec-9980-4bab-9b83-e883f8c30870",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-22T20:03:30.6875457+00:00",
"id2": 60
},
"db_language_id": "12fae7dd-d4c1-432e-b126-e1d48de92d1b",
"db_language_code": "sample string 7",
"db_title_id": "ff38fcef-7403-49be-b8c4-ddd1a7491bd6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-22T20:03:30.6875457+00:00",
"create_date": "2025-10-22T20:03:30.6875457+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-10-22T20:03:30.6875457+00:00"
}