Retrieve Client Profile
Retrieve the profile details associated with a specific client.
This endpoint retrieves the detailed profile of a specified client, organized into groups of fields. The profile includes both default fields in the "Basic" group and custom fields in other groups. Each field contains data that depends on its type.
Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/profile/" \
-u <token>: \
-X GET
Request Parameters:
client_id: The ID of the client whose profile you wish to retrieve. This field is required and must correspond to an existing client.
Example Success Response:
The basic group is now deprecated and will be removed in the future. Please update your applications to ensure they use the new custom fields to avoid disruptions.
[
{
"group_name": "Profile Group",
"group_id": 1,
"fields": {
"prof_1482": {
"label": "Favorite Colors",
"type": "MultiSelect",
"value": [
{
"choice": 1,
"choice_label": "Red"
},
{
"choice": 2,
"choice_label": "Blue"
}
]
},
"prof_484": {
"label": "Subscription Type",
"type": "Select",
"value": {
"choice": 1,
"choice_label": "Premium"
}
},
"prof_489": {
"label": "Height",
"type": "Height (cm - ft & in)",
"value": 1510
},
"prof_490": {
"label": "Number of Logins",
"type": "Integer Number",
"value": 102
},
"prof_491": {
"label": "Membership Start Date",
"type": "Date",
"value": "2023-01-15"
},
"prof_492": {
"label": "Date of Birth",
"type": "Birthday (Age)",
"value": "1990-05-20"
},
"prof_493": {
"label": "Preferred Contact Time",
"type": "Time",
"value": "14:30:00"
},
"prof_494": {
"label": "Annual Revenue",
"type": "Fractional Number",
"value": 1500000.50
},
"prof_495": {
"label": "Profile Picture",
"type": "Image",
"value": {
"name": "profile-pic.jpg",
"url": "https://link/to/profile-pic.jpg"
}
},
"prof_502": {
"label": "Newsletter Subscription",
"type": "Yes/No",
"value": true
},
"prof_503": {
"label": "Weight",
"type": "Weight (International)",
"value": 25000
},
"prof_504": {
"label": "Secondary Phone",
"type": "PhoneNumber",
"value": "+123 987 6543"
},
"prof_512": {
"label": "Short Bio",
"type": "Short Text",
"value": "A brief description about the client."
},
"prof_513": {
"label": "Comments",
"type": "Long Text",
"value": "Client prefers contact via email."
},
"prof_1483": {
"label": "Some Link",
"type": "Web Link",
"value": "https://some_link.com"
},
"prof_489": {
"label": "Height (cm - ft & in)",
"type": "Height (cm - ft & in)",
"value": 1510
},
"prof_1515": {
"label": "Location",
"type": "Location",
"value": {
"country": "CA",
"city": "Vaughan",
"state": "ON",
"zip_code": "L6A 1S6",
"suit": "",
"street": "",
"distance": ""
}
}
}
}
]Field Types:
The fields in the client profile are of various types, each having a specific structure:
Integer Number: A numerical field that contains an integer value.
Fractional Number: A numerical field that contains a floating-point value (a number with decimals).
Date: A field that contains a date value in the format YYYY-MM-DD.
Time: A field that contains a time value in the format HH:MM:SS.
Birthday (Age): A field that contains a date value representing a birthday in the format YYYY-MM-DD.
Short Text, Long Text: A string containing the text value.
Yes/No: A boolean value (true or false).
MultiSelect: A list of dictionaries, each containing a choice and a choice_label.
Select: A dictionary with choice and choice_label keys.
Web Link: A URL string.
File, Image: A dictionary containing name and url keys pointing to a file or image resource.
PhoneNumber: A string representing a phone number.
Height (cm - ft & in): A field that contains a numerical value representing height in millimeters.
Available choices:
1400 - 140cm - 4' 7",
1410 - 141cm - 4' 8",
1420 - 142cm - 4' 8",
1430 - 143cm - 4' 8",
1440 - 144cm - 4' 9",
1450 - 145cm - 4' 9",
1460 - 146cm - 4' 9",
1470 - 147cm - 4' 10",
1480 - 148cm - 4' 10",
1490 - 149cm - 4' 11",
1500 - 150cm - 4' 11",
1510 - 151cm - 4' 11",
1520 - 152cm - 5' 0",
1530 - 153cm - 5' 0",
1540 - 154cm - 5' 1",
1550 - 155cm - 5' 1",
1560 - 156cm - 5' 1",
1570 - 157cm - 5' 2",
1580 - 158cm - 5' 2",
1590 - 159cm - 5' 3",
1600 - 160cm - 5' 3",
1610 - 161cm - 5' 3",
1620 - 162cm - 5' 4",
1630 - 163cm - 5' 4",
1640 - 164cm - 5' 5",
1650 - 165cm - 5' 5",
1660 - 166cm - 5' 5",
1670 - 167cm - 5' 6",
1680 - 168cm - 5' 6",
1690 - 169cm - 5' 7",
1700 - 170cm - 5' 7",
1710 - 171cm - 5' 7",
1720 - 172cm - 5' 8",
1730 - 173cm - 5' 8",
1740 - 174cm - 5' 9",
1750 - 175cm - 5' 9",
1760 - 176cm - 5' 9",
1770 - 177cm - 5' 10",
1780 - 178cm - 5' 10",
1790 - 179cm - 5' 10",
1800 - 180cm - 5' 11",
1810 - 181cm - 5' 11",
1820 - 182cm - 6' 0",
1830 - 183cm - 6' 0",
1840 - 184cm - 6' 0",
1850 - 185cm - 6' 1",
1860 - 186cm - 6' 1",
1870 - 187cm - 6' 2",
1880 - 188cm - 6' 2",
1890 - 189cm - 6' 2",
1900 - 190cm - 6' 3",
1910 - 191cm - 6' 3",
1920 - 192cm - 6' 4",
1930 - 193cm - 6' 4",
1940 - 194cm - 6' 4",
1950 - 195cm - 6' 5",
1960 - 196cm - 6' 5",
1970 - 197cm - 6' 6",
1980 - 198cm - 6' 6",
1990 - 199cm - 6' 6",
2000 - 200cm - 6' 7",
2010 - 201cm - 6' 7",
2020 - 202cm - 6' 8",
2030 - 203cm - 6' 8",
2040 - 204cm - 6' 8",
2050 - 205cm - 6' 9",
2060 - 206cm - 6' 9",
2070 - 207cm - 6' 9",
2080 - 208cm - 6' 10",
2090 - 209cm - 6' 10",
2100 - 210cm - 6' 11",
2110 - 211cm - 6' 11",
2120 - 212cm - 6' 11",
2130 - 213cm - 7' 0",
2140 - 214cm - 7' 0",
2150 - 215cm - 7' 1",
2160 - 216cm - 7' 1",
2170 - 217cm - 7' 1",
2180 - 218cm - 7' 2",
2190 - 219cm - 7' 2",
2200 - 220cm - 7' 3",
2210 - 221cm - 7' 3",
2220 - 222cm - 7' 3",
2230 - 223cm - 7' 4",
2240 - 224cm - 7' 4",
2250 - 225cm - 7' 5",
2260 - 226cm - 7' 5",
2270 - 227cm - 7' 5",
2280 - 228cm - 7' 6",
2290 - 229cm - 7' 6",
2300 - 230cm - 7' 7",
2310 - 231cm - 7' 7",
2320 - 232cm - 7' 7",
2330 - 233cm - 7' 8",
2340 - 234cm - 7' 8",
2350 - 235cm - 7' 9",
2360 - 236cm - 7' 9",
2370 - 237cm - 7' 9",
2380 - 238cm - 7' 10"
Height (ft & in): A field that contains a numerical value representing height in feet and inches.
Available choices:
1219 - 4' 0",
1245 - 4' 1",
1270 - 4' 2",
1295 - 4' 3",
1321 - 4' 4",
1346 - 4' 5",
1372 - 4' 6",
1397 - 4' 7",
1422 - 4' 8",
1448 - 4' 9",
1473 - 4' 10",
1499 - 4' 11",
1524 - 5' 0",
1549 - 5' 1",
1575 - 5' 2",
1600 - 5' 3",
1626 - 5' 4",
1651 - 5' 5",
1676 - 5' 6",
1702 - 5' 7",
1727 - 5' 8",
1753 - 5' 9",
1778 - 5' 10",
1803 - 5' 11",
1829 - 6' 0",
1854 - 6' 1",
1880 - 6' 2",
1905 - 6' 3",
1930 - 6' 4",
1956 - 6' 5",
1981 - 6' 6",
2007 - 6' 7",
2032 - 6' 8",
2057 - 6' 9",
2083 - 6' 10",
2108 - 6' 11",
2134 - 7' 0",
2159 - 7' 1",
2184 - 7' 2",
2210 - 7' 3",
2235 - 7' 4",
2261 - 7' 5",
2286 - 7' 6",
2311 - 7' 7",
2337 - 7' 8",
2362 - 7' 9",
2388 - 7' 10",
2413 - 7' 11",
Weight (International): A field that contains a numerical value representing weight in grams.
Available choices:
20000 - 20kg - 44lbs,
21000 - 21kg - 46lbs,
22000 - 22kg - 48lbs,
23000 - 23kg - 50lbs,
24000 - 24kg - 52lbs,
25000 - 25kg - 55lbs,
26000 - 26kg - 57lbs,
27000 - 27kg - 59lbs,
28000 - 28kg - 61lbs,
29000 - 29kg - 63lbs,
30000 - 30kg - 66lbs,
31000 - 31kg - 68lbs,
32000 - 32kg - 70lbs,
33000 - 33kg - 72lbs,
34000 - 34kg - 74lbs,
35000 - 35kg - 77lbs,
36000 - 36kg - 79lbs,
37000 - 37kg - 81lbs,
38000 - 38kg - 83lbs,
39000 - 39kg - 85lbs,
40000 - 40kg - 88lbs,
41000 - 41kg - 90lbs,
42000 - 42kg - 92lbs,
43000 - 43kg - 94lbs,
44000 - 44kg - 97lbs,
45000 - 45kg - 99lbs,
46000 - 46kg - 101lbs,
47000 - 47kg - 103lbs,
48000 - 48kg - 105lbs,
49000 - 49kg - 108lbs,
50000 - 50kg - 110lbs,
51000 - 51kg - 112lbs,
52000 - 52kg - 114lbs,
53000 - 53kg - 116lbs,
54000 - 54kg - 119lbs,
55000 - 55kg - 121lbs,
56000 - 56kg - 123lbs,
57000 - 57kg - 125lbs,
58000 - 58kg - 127lbs,
59000 - 59kg - 130lbs,
60000 - 60kg - 132lbs,
61000 - 61kg - 134lbs,
62000 - 62kg - 136lbs,
63000 - 63kg - 138lbs,
64000 - 64kg - 141lbs,
65000 - 65kg - 143lbs,
66000 - 66kg - 145lbs,
67000 - 67kg - 147lbs,
68000 - 68kg - 149lbs,
69000 - 69kg - 152lbs,
70000 - 70kg - 154lbs,
71000 - 71kg - 156lbs,
72000 - 72kg - 158lbs,
73000 - 73kg - 160lbs,
74000 - 74kg - 163lbs,
75000 - 75kg - 165lbs,
76000 - 76kg - 167lbs,
77000 - 77kg - 169lbs,
78000 - 78kg - 171lbs,
79000 - 79kg - 174lbs,
80000 - 80kg - 176lbs,
81000 - 81kg - 178lbs,
82000 - 82kg - 180lbs,
83000 - 83kg - 182lbs,
84000 - 84kg - 185lbs,
85000 - 85kg - 187lbs,
86000 - 86kg - 189lbs,
87000 - 87kg - 191lbs,
88000 - 88kg - 194lbs,
89000 - 89kg - 196lbs,
90000 - 90kg - 198lbs,
91000 - 91kg - 200lbs,
92000 - 92kg - 202lbs,
93000 - 93kg - 205lbs,
94000 - 94kg - 207lbs,
95000 - 95kg - 209lbs,
96000 - 96kg - 211lbs,
97000 - 97kg - 213lbs,
98000 - 98kg - 216lbs,
99000 - 99kg - 218lbs,
100000 - 100kg - 220lbs,
101000 - 101kg - 222lbs,
102000 - 102kg - 224lbs,
103000 - 103kg - 227lbs,
104000 - 104kg - 229lbs,
105000 - 105kg - 231lbs,
106000 - 106kg - 233lbs,
107000 - 107kg - 235lbs,
108000 - 108kg - 238lbs,
109000 - 109kg - 240lbs,
110000 - 110kg - 242lbs,
111000 - 111kg - 244lbs,
112000 - 112kg - 246lbs,
113000 - 113kg - 249lbs,
114000 - 114kg - 251lbs,
115000 - 115kg - 253lbs,
116000 - 116kg - 255lbs,
117000 - 117kg - 257lbs,
118000 - 118kg - 260lbs,
119000 - 119kg - 262lbs,
120000 - 120kg - 264lbs,
121000 - 121kg - 266lbs,
122000 - 122kg - 268lbs,
123000 - 123kg - 271lbs,
124000 - 124kg - 273lbs,
125000 - 125kg - 275lbs,
126000 - 126kg - 277lbs,
127000 - 127kg - 279lbs,
128000 - 128kg - 282lbs,
129000 - 129kg - 284lbs,
130000 - 130kg - 286lbs,
131000 - 131kg - 288lbs,
132000 - 132kg - 291lbs,
133000 - 133kg - 293lbs,
134000 - 134kg - 295lbs,
135000 - 135kg - 297lbs,
136000 - 136kg - 299lbs,
137000 - 137kg - 302lbs,
138000 - 138kg - 304lbs,
139000 - 139kg - 306lbs,
140000 - 140kg - 308lbs,
141000 - 141kg - 310lbs,
142000 - 142kg - 313lbs,
143000 - 143kg - 315lbs,
144000 - 144kg - 317lbs,
145000 - 145kg - 319lbs,
146000 - 146kg - 321lbs,
147000 - 147kg - 324lbs,
148000 - 148kg - 326lbs,
149000 - 149kg - 328lbs,
Location: A dictionary containing location details, such as country, city, state, zip_code, etc.
Available Country Choices:
US - United States
CA - Canada
GB - United Kingdom
AF - Afghanistan
AL - Albania
DZ - Algeria
AD - Andorra
AO - Angola
AR - Argentina
AM - Armenia
AU - Australia
AT - Austria
AZ - Azerbaijan
BS - Bahamas
BH - Bahrain
BD - Bangladesh
BY - Belarus
BE - Belgium
BZ - Belize
BJ - Benin
BM - Bermuda
BT - Bhutan
BO - Bolivia, Plurinational State of
BA - Bosnia and Herzegovina
BW - Botswana
BR - Brazil
BN - Brunei Darussalam
BG - Bulgaria
BF - Burkina Faso
KH - Cambodia
CM - Cameroon
KY - Cayman Islands
CF - Central African Republic
TD - Chad
CL - Chile
CN - China
CO - Colombia
CG - Congo
CD - Congo, The Democratic Republic of the
CR - Costa Rica
CI - Côte D'ivoire
HR - Croatia
CY - Cyprus
CZ - Czech Republic
DK - Denmark
DJ - Djibouti
DO - Dominican Republic
EC - Ecuador
EG - Egypt
GQ - Equatorial Guinea
ET - Ethiopia
FI - Finland
FR - France
GA - Gabon
GM - Gambia
GE - Georgia
DE - Germany
GH - Ghana
GI - Gibraltar
GR - Greece
GN - Guinea
HN - Honduras
HK - Hong Kong
HU - Hungary
IS - Iceland
IN - India
ID - Indonesia
IQ - Iraq
IE - Ireland
IL - Israel
IT - Italy
JM - Jamaica
JP - Japan
JO - Jordan
KZ - Kazakhstan
KE - Kenya
KR - Korea, Republic of
KW - Kuwait
LA - Lao People's Democratic Republic
LV - Latvia
LB - Lebanon
LR - Liberia
LY - Libya
LT - Lithuania
LU - Luxembourg
MG - Madagascar
MY - Malaysia
MV - Maldives
ML - Mali
MT - Malta
MU - Mauritius
MX - Mexico
MC - Monaco
MN - Mongolia
ME - Montenegro
MA - Morocco
MZ - Mozambique
NA - Namibia
NP - Nepal
NL - Netherlands
NZ - New Zealand
NE - Niger
NG - Nigeria
NO - Norway
OM - Oman
PK - Pakistan
PA - Panama
PG - Papua New Guinea
PY - Paraguay
PE - Peru
PH - Philippines
PL - Poland
PT - Portugal
QA - Qatar
RO - Romania
RU - Russian Federation
SA - Saudi Arabia
SN - Senegal
RS - Serbia
SG - Singapore
SK - Slovakia
SI - Slovenia
ZA - South Africa
ES - Spain
LK - Sri Lanka
SZ - Swaziland
SE - Sweden
CH - Switzerland
SY - Syrian Arab Republic
TW - Taiwan
TZ - Tanzania, United Republic of
TH - Thailand
TG - Togo
TN - Tunisia
TR - Turkey
UG - Uganda
UA - Ukraine
AE - United Arab Emirates
UY - Uruguay
VE - Venezuela, Bolivarian Republic of
VN - Vietnam
ZM - Zambia
ZW - Zimbabwe
Group Structure:
Custom Groups: Other groups contain custom fields which may vary by client. These fields can include anything from subscription types to additional contact information.
Base Request:
Method: GET
Authentication: Basic Authentication. Requires a valid <token> passed.
Rate Limits:
30 requests within 10 seconds
Error Responses:
| 401 | Unauthorized |
This error occurs when the <token> is missing, invalid, or the API access is disabled. Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled" |
| 404 | Not Found |
This error occurs if the client with the specified ID does not exist. |
| 405 | Method Not Allowed |
This error occurs if an HTTP method other than GET is used (e.g., POST or PUT). |
| 429 | Too Many Requests |
This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server. Possible errors: "too many requests" |
| 500 | Server Error |
Possible errors: "Internal server error" |
Available Fields:
The field ids, labels, types, and available values below are generic samples. Every agency defines its own custom fields, so your agency's own live list appears in its private copy of these API docs.
| Title | Name | Type | |
|---|---|---|---|
| Example Group (ID: 1) | |||
| First Name | prof_1 | Text | |
| Country | prof_2 | Select |
Show Values
|