GET Group member details
Overview
The group member details endpoint returns a detailed data structure for a group member (i.e. a patient or study participant). A valid group UUID and user UUID combination is required, or a group member href. Use the group member list endpoint to discover group members.
Path parameters
GROUP_UUID |
(string) The unique identifier for a group. |
userUuid |
(string) The unique identifier for a user. |
Curl example
curl -X GET \
'https://API_HOSTNAME/api/v1/groups/GROUP_UUID/members/\
USER_UUID --header 'Authorization: Bearer BEARER_TOKEN'
Response body
{
"href": "/api/v1/groups/GROUP_UUID/members/USER_UUID",
"group": {
"href": "/api/v1/groups/GROUP_UUID",
"title": "My Group"
},
"user": {
"birthDate": "2000-01-01",
"email": "jdoe@example.com",
"firstName": "John",
"lastName": "Doe",
"gender": "male",
"locale": "en-US",
"mobileNumber": "+19195551212",
"timeZone": "America/New_York",
"uuid": "USER_UUID"
},
"plan": {
"href": "/api/v1/groups/GROUP_UUID/plans/PLAN_UUID",
"title": "My Plan"
},
"planSettings": {},
"attributes": {
"string_attribute": "test value",
"boolean_attribute": false
},
"tags": [
"Tag1",
"Tag2",
"Tag3"
]
}
Result attributes
userUuid |
(string) A unique identifier for the group member. |
group |
(link) A reference to the group of the member. |
firstName |
(string) The first name of the group member. |
lastName |
(string) The last name of the group member. |
birthdate |
(string) The birthdate of the group member, expressed in ISO 8601 standard format (yyyy-MM-dd). |
gender |
(string) The gender of the group member. Possible values are male, female, other, preferNotToSay |
timeZone |
(string) The group member’s current time zone, expressed in IANA standard format. Example: America/New_York |
mobileNumber |
(string) The group member’s mobile number. |
(string) The group member’s email address. |
|
plan |
(link) A reference to the group member’s plan, if one exists. |
planStartDate |
(date) The date that the plan was activated for the user. |
attributes |
A JSON subdocument that contains a list of custom group member attribute keys and values. |
tags |
A list of tags assigned to the group member |