GET Customers/{id}?idType={idType}&idTypeExtRef={idTypeExtRef}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
Required |
|
| idType | integer |
Default value is 0 |
|
| idTypeExtRef | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Customer| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerId |
QFlow Customer Id |
integer |
None. |
| PersonalId |
Vendor's Customer identifier |
string |
Max length: 30 |
| PersonalIdTypeId |
Vendor's Customer identifier Type (QFlow CustomerIdTypeId). 0 =none, null=first available |
integer |
None. |
| PersonalIdTypeExtRef | string |
None. |
|
| FirstName |
First Name |
string |
Max length: 50 |
| LastName |
Last Name |
string |
Max length: 50 |
|
Email address |
string |
Max length: 100 |
|
| TelNumber1 |
Phone Number 1 |
string |
Max length: 25 |
| TelNumber2 |
Phone Number 2 |
string |
Max length: 25 |
| DOB |
Date of Birth |
date |
None. |
| Sex |
0=Unknown; 1=Male; 2=Female |
byte |
Range: inclusive between 0 and 2 |
| Notes |
Notes |
string |
Max length: 250 |
| ExtRef |
Custom External Reference |
string |
Max length: 200 |
| NotificationConsent | boolean |
None. |
|
| IsActive |
Is customer record enabled |
boolean |
None. |
| CustomProperties |
Collection of all custom properties for this customer |
Dictionary of string [key] and string [value] |
None. |
Response Formats
application/json, text/json
Sample:
{
"CustomerId": 1,
"PersonalId": "sample string 2",
"PersonalIdTypeId": 1,
"PersonalIdTypeExtRef": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"Email": "sample string 6",
"TelNumber1": "sample string 7",
"TelNumber2": "sample string 8",
"DOB": "2026-04-05T04:15:57.2773368+10:00",
"Sex": 64,
"Notes": "sample string 9",
"ExtRef": "sample string 10",
"NotificationConsent": true,
"IsActive": true,
"CustomProperties": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}