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": "f331f504-e684-4603-b809-384c3991cb4b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "29f8d7e2-d7a3-4849-837e-ed049d8b5ca7",
"company_code": "sample string 5",
"company": {
"id": "9cfcf429-a0ed-411d-a87d-fe4743dba66f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-02-22T17:44:02.101038+00:00",
"sales_territory_id": "5b1c706b-5853-4dde-a98b-77b9072be839",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "50b3fee2-c22f-4e34-ae39-4eabc260af3e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "16f91e18-f6a0-4bc3-a7fe-a74d6c31bb78",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e605cc57-d996-45b7-82b2-43b8324cca97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ca93556-dbda-4718-9d76-a22276dcf554",
"db_currency_id": "b7a1dfe1-acae-414a-9bae-249b2d03e7ff",
"db_language_id": "0b745aec-1855-42eb-918d-e219a30e515d",
"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-02-22T17:44:02.101038+00:00"
},
"modified_dateutc": "2025-02-22T17:44:02.101038+00:00"
},
"marketing_segment_id": "8d46fea1-83e9-4a4a-b0b9-f4d450562060",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "dd9335ab-7a4b-467c-bbb2-ada975eaac47",
"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": "a4978033-04cc-4cda-9b1a-45a748437c18",
"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": "548ee1ab-f613-4010-80f6-29325a3eef7a",
"db_country_code": "sample string 28",
"feelist_id": "b360c126-1c72-4d45-885d-f3dca0077fb8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bd584ff4-a3f2-4fc8-98f3-4df599d14162",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "13755658-5236-48fb-a5cd-c66fa0c0711f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-02-22T17:44:02.101038+00:00",
"db_currency_id": "6fa7e5c3-d4da-486d-8a3e-ce49d972ad09",
"db_currency_code": "sample string 10"
},
"company_type_id": "0e241961-25c9-4687-9a09-84076499556d",
"company_type_name": "sample string 32",
"company_type": {
"id": "33044389-a437-4385-8092-e949a61ea2f1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3da5e347-d3ff-4363-b05a-0c1aa3dcfb88",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aec18b2f-d132-47f0-a950-144a8f110697",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "97aba30b-aa96-4d13-88a3-0e5a5883940c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e8f5929e-f664-4625-91b7-dce74177d2ae",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f32b8e2e-55be-47ee-9c7d-1fd209f04521",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-02-22T17:44:02.101038+00:00"
},
"company_sector_id": "7a27c730-b7af-4f87-8b6a-1ac886f64a56",
"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": "fc61c389-16a6-4a7d-938a-3b1910e2cb35",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "916352a8-ed9e-4e37-8ff1-490e16583c93",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5b72ee1e-195f-4030-a44f-3722c6acaf02",
"account_manager_user_code": "sample string 56",
"company_status_id": "a8ba77ed-c1c2-4fd7-90c9-9b9407e4f226",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-02-22T17:44:02.101038+00:00",
"id2": 60
},
"db_language_id": "76485aef-83ac-4331-8b5c-ce5a78bd9181",
"db_language_code": "sample string 7",
"db_title_id": "7aaae464-78ee-4ff5-abf5-2894a091ee1b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-02-22T17:44:02.101038+00:00",
"create_date": "2025-02-22T17:44:02.101038+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-02-22T17:44:02.101038+00:00"
}