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": "c9053eb8-81a4-4715-bb28-7d786f7dcf57",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b42f12f6-0baa-4a09-851c-2349843d8c62",
"company_code": "sample string 5",
"company": {
"id": "3d848cf5-5389-4376-9ec7-9b6c418660d1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-30T02:38:16.753186+00:00",
"sales_territory_id": "c36ccb37-bc4c-4baa-a56c-5f9d4e77806b",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4a40f1ac-f293-4caa-ace6-55ccf543d88e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d43c0330-eaed-4727-8402-d4865b427e37",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f44a754e-f612-42c2-8a30-39d18bfa525e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "efc82123-735d-4acc-8077-4865be70e327",
"db_currency_id": "0b2675cb-e1d6-47c5-8b8b-b5e60fdaeb01",
"db_language_id": "8c1262d8-1b39-4f0d-bfbb-87a2f7b12ef6",
"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": "2026-05-30T02:38:16.753186+00:00"
},
"modified_dateutc": "2026-05-30T02:38:16.753186+00:00"
},
"marketing_segment_id": "74f80c3b-3286-4589-946e-a8344e457dd0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f02d18ae-6cc8-4db2-9fbf-161ba89fe02a",
"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": "cd7e6c7f-cd01-40a7-808c-5d0cd71da671",
"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": "aadd3dc7-69ad-4d90-9a87-f757cfa94332",
"db_country_code": "sample string 28",
"feelist_id": "c4187fef-5dd5-4619-8783-d93de0026d61",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2964f5f7-7839-4446-9633-b6a1adc75eac",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5e3c9b70-c0ad-4849-bfb4-e13ca0d1cb05",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-30T02:38:16.753186+00:00",
"db_currency_id": "0ae4d802-c5ce-464a-bf95-dc64c2204d68",
"db_currency_code": "sample string 10"
},
"company_type_id": "69cb9b2c-9d5a-49f6-a897-92b92787c67a",
"company_type_name": "sample string 32",
"company_type": {
"id": "1b4f3857-e0a1-444d-b27a-2c5062e0adb4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "60b9a455-60a7-4002-ab14-11f6dab9b5a6",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fd97e5b3-94fb-4c17-8981-9d05b317438e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "01011f7d-eb5f-4c2c-8103-ea5d832d4d81",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4c8f0ee6-0e77-4589-9cbf-55254a601011",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b8cae1a3-d9cb-4ebc-997a-3ef9b0b1e0a6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-30T02:38:16.753186+00:00"
},
"company_sector_id": "633dfd64-e204-416e-950a-91e9c7f6fd56",
"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": "60bb30b0-17f9-4128-bdcf-3219d655786e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d3da33a5-6060-41f7-a075-719b2cdf6aa1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d16f830e-e1b0-4717-87f0-af39e8dc71db",
"account_manager_user_code": "sample string 56",
"company_status_id": "8fe0a768-7c99-4385-961b-5669d0235a34",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-30T02:38:16.753186+00:00",
"id2": 60
},
"db_language_id": "4205f265-03e6-4cb5-9a70-9e3fba3e5c34",
"db_language_code": "sample string 7",
"db_title_id": "8e24a3cf-ce1d-47e9-9775-6a7c0f879983",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-30T02:38:16.753186+00:00",
"create_date": "2026-05-30T02:38:16.753186+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": "2026-05-30T02:38:16.753186+00:00"
}