Get Started
- Authentication
App-Scoped Endpoints
- Groups
- Group Invitations
- Group Members
- Magic Links
- OpenID Clients
- User Profiles
- User Sessions
User-Scoped Endpoints
- Groups
- Group Invitations
- Group Members
- User Profiles
List user profiles
curl --request GET \
--url https://api.rownd.io/applications/{app}/users/data \
--header 'x-rownd-app-key: <api-key>' \
--header 'x-rownd-app-secret: <api-key>'
{
"total_results": 123,
"results": [
{
"rownd_user": "user_a7b53gwdaml5jt7t71442nt7",
"state": "enabled",
"auth_level": "verified",
"attributes": {
"rownd:app_variants": [
"app_variant_1",
"app_variant_2"
],
"myapp:subscription_status": [
"active"
],
"myapp:loyalty_points": [
"100"
]
},
"data": {
"user_id": "user_a7b53gwdaml5jt7t71442nt7",
"email": "gary@foo.com",
"first_name": "Gary",
"last_name": "Jackson"
},
"verified_data": {
"email": "gary@foo.com",
"phone_number": "+19199993333"
},
"groups": [
{
"group": {
"id": "group_a3l1n2lsnb3q0xbul9enjnh7",
"name": "My Teammates",
"member_count": 0,
"app_id": "327677849595019856",
"admission_policy": "invite_only",
"meta": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "user_t6ftnnmw55pamuhfo9xvw0yl",
"created_by": "user_t6ftnnmw55pamuhfo9xvw0yl"
},
"member": {
"id": "member_dnn5g4e3q6aptail2gr43kpj",
"user_id": "user_fbylaq38591cghym5pabupj2",
"roles": [
"owner",
"editor"
],
"state": "active",
"invited_by": "<string>",
"added_by": "<string>",
"profile": {
"user_id": "user_a7b53gwdaml5jt7t71442nt7",
"email": "gary@foo.com",
"first_name": "Gary",
"last_name": "Jackson"
},
"group_id": "group_ig42thhwf4cig25o7t9jtlyu"
}
}
],
"meta": {
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"first_sign_in": "2023-11-07T05:31:56Z",
"first_sign_in_method": "<string>",
"last_sign_in": "2023-11-07T05:31:56Z",
"last_sign_in_method": "<string>",
"last_active": "2023-11-07T05:31:56Z",
"last_passkey_registration_prompt": "2023-11-07T05:31:56Z"
},
"connection_map": {}
}
]
}
Authorizations
The publishable key of your application credentials. (more details)
The private secret of your application credentials. (more details)
Path Parameters
Rownd application ID
Query Parameters
Comma-separated list of fields to include in the profile data
"email,first_name"
Return resources that match this filter
A comma-separated list of resource IDs to filter by
Number of resources to return per query. Max is 1000.
ID of the last resource in the previous page. If provided, the next page of results is returned beginning with this resource ID.
Which direction to sort the results
asc
, desc
Include multiple users if they are found using the lookup and id filters
Response
The number of results
The list of user profiles
The user's ID
"user_a7b53gwdaml5jt7t71442nt7"
The user's state
enabled
, disabled
The user's authentication level
"verified"
User profile attributes
{
"rownd:app_variants": ["app_variant_1", "app_variant_2"],
"myapp:subscription_status": ["active"],
"myapp:loyalty_points": ["100"]
}
User profile data
User profile data that has been verified
{
"email": "gary@foo.com",
"phone_number": "+19199993333"
}
Groups in which the user is a member
The group
The group ID
"group_a3l1n2lsnb3q0xbul9enjnh7"
The group name
"My Teammates"
This value is no longer provided by the API. The default value of 0 will always be returned
Rownd application ID
"327677849595019856"
Set whether the group be open for anyone to join or by invite only
invite_only
, open
"invite_only"
An object containing additional metadata for the group
The ISO 8601 date-time that the resource was created
The ISO 8601 date-time that the resource was updated
The ID of the user that created the resource
"user_t6ftnnmw55pamuhfo9xvw0yl"
The ID of the user that most recently updated the resource
"user_t6ftnnmw55pamuhfo9xvw0yl"
The group member
The ID of a user to add as a group member. The user must belong to the Rownd application.
"user_fbylaq38591cghym5pabupj2"
The roles that the member belongs. (The first member added or invited to a group will always be created with the 'owner' role along with any additional roles specified)
["owner", "editor"]
The group member ID
"member_dnn5g4e3q6aptail2gr43kpj"
The state of the group member. A member that has been invited will not go into the active
state until they accept the invitation.
active
, invite_pending
, invite_rejected
The authenticated party that invited the user to the group
The authenticated party that added the user to the gruop
User profile data
The group ID
"group_ig42thhwf4cig25o7t9jtlyu"
curl --request GET \
--url https://api.rownd.io/applications/{app}/users/data \
--header 'x-rownd-app-key: <api-key>' \
--header 'x-rownd-app-secret: <api-key>'
{
"total_results": 123,
"results": [
{
"rownd_user": "user_a7b53gwdaml5jt7t71442nt7",
"state": "enabled",
"auth_level": "verified",
"attributes": {
"rownd:app_variants": [
"app_variant_1",
"app_variant_2"
],
"myapp:subscription_status": [
"active"
],
"myapp:loyalty_points": [
"100"
]
},
"data": {
"user_id": "user_a7b53gwdaml5jt7t71442nt7",
"email": "gary@foo.com",
"first_name": "Gary",
"last_name": "Jackson"
},
"verified_data": {
"email": "gary@foo.com",
"phone_number": "+19199993333"
},
"groups": [
{
"group": {
"id": "group_a3l1n2lsnb3q0xbul9enjnh7",
"name": "My Teammates",
"member_count": 0,
"app_id": "327677849595019856",
"admission_policy": "invite_only",
"meta": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by": "user_t6ftnnmw55pamuhfo9xvw0yl",
"created_by": "user_t6ftnnmw55pamuhfo9xvw0yl"
},
"member": {
"id": "member_dnn5g4e3q6aptail2gr43kpj",
"user_id": "user_fbylaq38591cghym5pabupj2",
"roles": [
"owner",
"editor"
],
"state": "active",
"invited_by": "<string>",
"added_by": "<string>",
"profile": {
"user_id": "user_a7b53gwdaml5jt7t71442nt7",
"email": "gary@foo.com",
"first_name": "Gary",
"last_name": "Jackson"
},
"group_id": "group_ig42thhwf4cig25o7t9jtlyu"
}
}
],
"meta": {
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"first_sign_in": "2023-11-07T05:31:56Z",
"first_sign_in_method": "<string>",
"last_sign_in": "2023-11-07T05:31:56Z",
"last_sign_in_method": "<string>",
"last_active": "2023-11-07T05:31:56Z",
"last_passkey_registration_prompt": "2023-11-07T05:31:56Z"
},
"connection_map": {}
}
]
}