Get Contact by email
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
|
Email of contact |
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": "cdd8f864-1eb0-4a84-b900-9e38f18432d1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ac70b8f6-1cab-46ed-9e04-85660c328d74",
"company_code": "sample string 5",
"company": {
"id": "1e0049fb-1d2f-4aeb-b127-d494d52d32b4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-13T00:07:26.7382327+00:00",
"sales_territory_id": "5b886442-6747-445f-85bd-066f15beaec0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8aa83005-58b3-45b4-a28f-7145aabcb2e5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8b1460f-5985-4fda-877b-c8e4d042b6de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03136a41-9c40-44b3-9d23-5d82cc81bbaa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "513b7f1b-82fc-45f3-afd8-a2887f9e7058",
"db_currency_id": "af570a1f-0052-41c3-8e8a-93a8d6aa3c2e",
"db_language_id": "0af0e505-d77b-4baa-af5f-2d424910f247",
"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-11-13T00:07:26.7538553+00:00"
},
"modified_dateutc": "2025-11-13T00:07:26.7538553+00:00"
},
"marketing_segment_id": "e455daef-044d-43ed-b8db-cc76379b50b3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5711ecff-90e6-463a-a700-26710c6e3b42",
"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": "4c871d96-1bb0-4a03-a32c-699af9e885a4",
"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": "0bf90ce4-305f-438e-8505-e283665c380f",
"db_country_code": "sample string 28",
"feelist_id": "63a093cf-826b-46ed-a645-db79d9630496",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7b8f7b65-4415-4660-97e1-0d00e20bacd0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "502e8410-0f14-4675-8ba2-031bc537a2ee",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-13T00:07:26.7538553+00:00",
"db_currency_id": "d99bf674-d48a-478e-9f19-dd43e7ee414d",
"db_currency_code": "sample string 10"
},
"company_type_id": "21ac0ef6-eeca-4989-b3ce-36c0bf2e58b2",
"company_type_name": "sample string 32",
"company_type": {
"id": "271eb00c-ce76-4742-8fdc-d311b64b3350",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7c440f74-4176-4c9d-b11f-3e2103e1ec4a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9756e6ad-9fca-4a37-abc8-3d56df09f277",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "78c168c4-6eb0-4ae5-a2e7-f3380f7a6e53",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ff162b55-154f-4dc9-91d7-9e1343c9b729",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "22e28d8c-60a7-4d25-be1a-0392c8b90319",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-13T00:07:26.7538553+00:00"
},
"company_sector_id": "166fc70f-6391-4829-840d-2aa5dd24c053",
"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": "9598092f-0737-4bd7-8fa1-32547b037933",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "bedc6540-24ff-43d4-b6db-e9f91307c411",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0e19451f-6600-4c26-85d1-778b9750be07",
"account_manager_user_code": "sample string 56",
"company_status_id": "4bc7bb56-bd05-44b7-98df-807b019a0f8e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-13T00:07:26.7538553+00:00",
"id2": 60
},
"db_language_id": "0ce4ec5b-fe84-4835-8708-d92993256a19",
"db_language_code": "sample string 7",
"db_title_id": "392d3b15-3921-4e97-926c-4018c4bd71c0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-13T00:07:26.7538553+00:00",
"create_date": "2025-11-13T00:07:26.7538553+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-11-13T00:07:26.7538553+00:00"
}