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 :
contactName | 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
{ "id": "674719ff-be69-4020-bb61-e97d119e018f", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "4a6d2364-d320-4740-99e2-af67c79bd24f", "company_code": "sample string 5", "company": { "id": "7d99644d-d783-4de8-99c4-cf9be504e6ee", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-03-31T13:23:30.3099942+00:00", "sales_territory_id": "5d75687a-d5c6-4b34-a190-21849d3efb59", "sales_territory_code": "sample string 9", "sales_territory": { "id": "80ef0fca-e4d1-4b03-899f-dc0a9c464626", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "929e0622-4a43-44f9-8504-7f6c45eb6e93", "sales_organization_code": "sample string 5", "sales_organization": { "id": "479119bc-069d-4bee-8f92-56a61af12eec", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "94b50067-cd72-41db-a8e9-51aac51a11b3", "db_currency_id": "0f1b77c1-684a-4a15-9d9f-9875a1b2d372", "db_language_id": "28fc21b2-f498-4620-9a3c-c0a657884cfb", "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-03-31T13:23:30.3099942+00:00" }, "modified_dateutc": "2025-03-31T13:23:30.3099942+00:00" }, "marketing_segment_id": "dfc2ff66-3a67-480f-b7f7-0e12364b5c1c", "marketing_segment_code": "sample string 11", "sales_organization_id": "376cf62f-0f08-49a5-ab6f-78fa6068a3b8", "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": "43e626f5-d790-4aa8-937b-a94934042485", "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": "13c3f114-9ee3-4a00-9e3f-a990477ba714", "db_country_code": "sample string 28", "feelist_id": "faea5319-80d2-40e9-8680-88d8d401b865", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "a711cbdd-0e71-46b2-aef7-62427838622b", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "430f20b8-4fff-4d18-9aac-168a210e1044", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-03-31T13:23:30.3099942+00:00", "db_currency_id": "00ce3dfd-bb43-4bc2-82d3-c134b8a15336", "db_currency_code": "sample string 10" }, "company_type_id": "da121b69-65e6-4751-a793-65747f41730f", "company_type_name": "sample string 32", "company_type": { "id": "bded2517-0db6-4166-a574-a003fceff240", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "ed436393-0126-4eaf-9823-694f5021b498", "sales_organization_code": "sample string 5" }, "db_language_id": "34596e1e-7f9d-4849-b894-4c65a16d842b", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "2dc16362-333d-4b4a-8d5f-6ee160a6286b", "article_price_label_code": "sample string 37", "db_payment_method_id": "f64e5a64-ef4b-46f2-ba07-fdf48c7bb4db", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "a3bd5de2-bb1b-4d8a-8285-f95bd523c43d", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-03-31T13:23:30.3099942+00:00" }, "company_sector_id": "ece071de-20d9-40a4-b2ed-5c1ca7907f67", "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": "5ec3eac8-16b9-4a6f-bdaf-f1a19984cc0d", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "bd7db446-fba1-4197-8ada-d53493d4f667", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "e613d3c0-add3-4f5e-bb80-f1d571042278", "account_manager_user_code": "sample string 56", "company_status_id": "1256295d-d8a4-4e86-bc41-847f2f1c5543", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-03-31T13:23:30.3099942+00:00", "id2": 60 }, "db_language_id": "f01b26cf-88f6-4196-b9fb-d5b60d831c1f", "db_language_code": "sample string 7", "db_title_id": "2ae88084-991e-4dad-a401-11c80d8edc6c", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-03-31T13:23:30.3099942+00:00", "create_date": "2025-03-31T13:23:30.3099942+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-03-31T13:23:30.3099942+00:00" }