Get sample user profile data

cURL

curl --request GET \
  --url https://api.rownd.io/applications/{app}/users/__sample__/data \
  --header 'x-rownd-app-key: <api-key>' \
  --header 'x-rownd-app-secret: <api-key>'

{
  "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": "[email protected]",
    "first_name": "Gary",
    "last_name": "Jackson"
  },
  "verified_data": {
    "email": "[email protected]",
    "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": {
        "user_id": "user_fbylaq38591cghym5pabupj2",
        "roles": [
          "owner",
          "editor"
        ],
        "id": "member_dnn5g4e3q6aptail2gr43kpj",
        "state": "active",
        "invited_by": "<string>",
        "added_by": "<string>",
        "profile": {
          "user_id": "user_a7b53gwdaml5jt7t71442nt7",
          "email": "[email protected]",
          "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": {}
}

GET

applications

{app}

users

__sample__

data

cURL

curl --request GET \
  --url https://api.rownd.io/applications/{app}/users/__sample__/data \
  --header 'x-rownd-app-key: <api-key>' \
  --header 'x-rownd-app-secret: <api-key>'

{
  "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": "[email protected]",
    "first_name": "Gary",
    "last_name": "Jackson"
  },
  "verified_data": {
    "email": "[email protected]",
    "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": {
        "user_id": "user_fbylaq38591cghym5pabupj2",
        "roles": [
          "owner",
          "editor"
        ],
        "id": "member_dnn5g4e3q6aptail2gr43kpj",
        "state": "active",
        "invited_by": "<string>",
        "added_by": "<string>",
        "profile": {
          "user_id": "user_a7b53gwdaml5jt7t71442nt7",
          "email": "[email protected]",
          "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

x-rownd-app-key

string

header

required

The publishable key of your application credentials. (more details)

x-rownd-app-secret

string

header

required

The private secret of your application credentials. (more details)

Path Parameters

app

string

required

Rownd application ID

Response

200 - application/json

User record retrieved successfully

rownd_user

string

The user's ID

Example:

"user_a7b53gwdaml5jt7t71442nt7"

state

enum<string>

default:enabled

The user's state

Available options:

enabled,

disabled

auth_level

string

The user's authentication level

Example:

"verified"

attributes

object

User profile attributes

Show child attributes

attributes.{key}

string[]

Example:

{
  "rownd:app_variants": ["app_variant_1", "app_variant_2"],
  "myapp:subscription_status": ["active"],
  "myapp:loyalty_points": ["100"]
}

data

object

User profile data

Example:

{
  "user_id": "user_a7b53gwdaml5jt7t71442nt7",
  "email": "[email protected]",
  "first_name": "Gary",
  "last_name": "Jackson"
}

verified_data

object

User profile data that has been verified

Example:

{
  "email": "[email protected]",
  "phone_number": "+19199993333"
}

groups

object[]

Groups in which the user is a member

Show child attributes

groups.group

object

required

The group

Show child attributes

groups.group.id

string

The group ID

Example:

"group_a3l1n2lsnb3q0xbul9enjnh7"

groups.group.name

string

The group name

Example:

"My Teammates"

groups.group.member_count

number

default:0

deprecated

This value is no longer provided by the API. The default value of 0 will always be returned

groups.group.app_id

string

Rownd application ID

Example:

"327677849595019856"

groups.group.admission_policy

enum<string>

default:invite_only

Set whether the group be open for anyone to join or by invite only

Available options:

invite_only,

open

Example:

"invite_only"

groups.group.meta

object

An object containing additional metadata for the group

groups.group.created_at

string<date-time>

The ISO 8601 date-time that the resource was created

groups.group.updated_at

string<date-time>

The ISO 8601 date-time that the resource was updated

groups.group.updated_by

string

The ID of the user that created the resource

Example:

"user_t6ftnnmw55pamuhfo9xvw0yl"

groups.group.created_by

string

The ID of the user that most recently updated the resource

Example:

"user_t6ftnnmw55pamuhfo9xvw0yl"

groups.member

object

required

The group member

Show child attributes

groups.member.user_id

string

required

The ID of a user to add as a group member. The user must belong to the Rownd application.

Example:

"user_fbylaq38591cghym5pabupj2"

groups.member.roles

string[]

required

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)

Example:

["owner", "editor"]

groups.member.id

string

The group member ID

Example:

"member_dnn5g4e3q6aptail2gr43kpj"

groups.member.state

enum<string>

The state of the group member. A member that has been invited will not go into the active state until they accept the invitation.

Available options:

active,

invite_pending,

invite_rejected

groups.member.invited_by

string

The authenticated party that invited the user to the group

groups.member.added_by

string

The authenticated party that added the user to the gruop

groups.member.profile

object

User profile data

Example:

{
  "user_id": "user_a7b53gwdaml5jt7t71442nt7",
  "email": "[email protected]",
  "first_name": "Gary",
  "last_name": "Jackson"
}

groups.member.group_id

string

The group ID

Example:

"group_ig42thhwf4cig25o7t9jtlyu"

Get Started

App-Scoped Endpoints

User-Scoped Endpoints

Get sample user profile data

Authorizations

Path Parameters

Response