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": "4c343ae3-f87e-4051-9b0f-e1c16dd5c24b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1bf741ac-4a4b-413d-9b0c-06e4ab8dce6f",
"company_code": "sample string 5",
"company": {
"id": "f6a99f12-6452-482e-9c2f-c694b2c9d816",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-02T08:41:20.6594564+00:00",
"sales_territory_id": "b7a89ff3-513a-4cff-a920-ab364b327684",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2586c657-c6e9-404d-a521-94f4955ebb7e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "30c08eac-b609-4373-826e-b9a95ce5da8e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1883ef6-9729-43d6-867b-a0641c4c90db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7eaad25f-62b2-4f69-aaeb-32e476909345",
"db_currency_id": "6cd592f8-f783-4b96-a8d0-76e68bc409e9",
"db_language_id": "021eb358-13b7-47fc-a01d-39aed152b1a4",
"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-07-02T08:41:20.6594564+00:00"
},
"modified_dateutc": "2025-07-02T08:41:20.6594564+00:00"
},
"marketing_segment_id": "767263e1-b176-481c-82fc-beaa71da4f88",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "9579d0c4-a995-42cd-abef-9e06ee6e06f9",
"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": "0240e072-d614-41af-9423-7f9b99aa7c26",
"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": "b22ac73d-24e7-44aa-a2cc-0aa317505cb2",
"db_country_code": "sample string 28",
"feelist_id": "942d1408-4777-451c-bd44-abb37e1d9d3d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "00289db7-95a0-41d8-89ad-31994b46d10a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b1e00f53-e488-4f75-9d12-f7a5f0ec8cd2",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-02T08:41:20.6753712+00:00",
"db_currency_id": "12cbe5a2-bc83-4c0d-9478-111d252b2f0d",
"db_currency_code": "sample string 10"
},
"company_type_id": "f4a8a64f-7a3b-49bb-85e4-d763b0a408f7",
"company_type_name": "sample string 32",
"company_type": {
"id": "4a453eaa-5a60-4351-b052-c402a76e37dc",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "318a69a2-483a-4e36-a757-552c881d2b7b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a2a2dd10-4313-47de-be1f-644ef480d07e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "546f10bd-d5b8-4cb5-94d2-661391af0207",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b30d544c-bfd0-4361-b896-815c21346187",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "80cd686b-4bdf-4783-9d07-e5d21c3b2d37",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-02T08:41:20.6753712+00:00"
},
"company_sector_id": "e9922c11-2ab9-4f58-8f06-61332817ca33",
"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": "fd2d580b-382c-4a8a-ba5b-1809e9f9f49b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "630c6e02-c02a-43d2-be8f-d1954a73c729",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "2911472c-3237-4ced-b94b-8d4232814932",
"account_manager_user_code": "sample string 56",
"company_status_id": "8933108d-33e3-4d43-b4d3-3580b769776d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-02T08:41:20.6753712+00:00",
"id2": 60
},
"db_language_id": "ca79011d-9402-4e1a-9ac7-233fe18e5c5f",
"db_language_code": "sample string 7",
"db_title_id": "157de824-f329-4803-9da4-d6e4db713eec",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-02T08:41:20.6753712+00:00",
"create_date": "2025-07-02T08:41:20.6753712+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-07-02T08:41:20.6753712+00:00"
}