List user profiles

cURL

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": "[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

data

cURL

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": "[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

Query Parameters

fields

string

Comma-separated list of fields to include in the profile data

Example:

"email,first_name"

lookup_filter

string

Return user profiles with verified values that match this filter. This is a comma-separated list of values.

id_filter

string

A comma-separated list of resource IDs to filter by

page_size

integer

Number of resources to return per query. Max is 1000.

after

string

ID of the last resource in the previous page. If provided, the next page of results is returned beginning with this resource ID.

sort

enum<string>

Which direction to sort the results

Available options:

asc,

desc

include_duplicates

boolean

Include multiple users if they are found using the lookup and id filters

Response

200 - application/json

User records retrieved successfully

total_results

number

The number of results

results

object[]

The list of user profiles

Show child attributes

results.rownd_user

string

The user's ID

Example:

"user_a7b53gwdaml5jt7t71442nt7"

results.state

enum<string>

default:enabled

The user's state

Available options:

enabled,

disabled

results.auth_level

string

The user's authentication level

Example:

"verified"

results.attributes

object

User profile attributes

Show child attributes

results.attributes.{key}

string[]

Example:

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

results.data

object

User profile data

Example:

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

results.verified_data

object

User profile data that has been verified

Example:

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

results.groups

object[]

Groups in which the user is a member

Show child attributes

results.groups.group

object

required

The group

Show child attributes

results.groups.group.id

string

The group ID

Example:

"group_a3l1n2lsnb3q0xbul9enjnh7"

results.groups.group.name

string

The group name

Example:

"My Teammates"

results.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

results.groups.group.app_id

string

Rownd application ID

Example:

"327677849595019856"

results.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"

results.groups.group.meta

object

An object containing additional metadata for the group

results.groups.group.created_at

string<date-time>

The ISO 8601 date-time that the resource was created

results.groups.group.updated_at

string<date-time>

The ISO 8601 date-time that the resource was updated

results.groups.group.updated_by

string

The ID of the user that created the resource

Example:

"user_t6ftnnmw55pamuhfo9xvw0yl"

results.groups.group.created_by

string

The ID of the user that most recently updated the resource

Example:

"user_t6ftnnmw55pamuhfo9xvw0yl"

results.groups.member

object

required

The group member

Show child attributes

results.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"

results.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"]

results.groups.member.id

string

The group member ID

Example:

"member_dnn5g4e3q6aptail2gr43kpj"

results.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

results.groups.member.invited_by

string

The authenticated party that invited the user to the group

results.groups.member.added_by

string

The authenticated party that added the user to the gruop

results.groups.member.profile

object

User profile data

Example:

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

results.groups.member.group_id

string

The group ID

Example:

"group_ig42thhwf4cig25o7t9jtlyu"

results.meta

object

Show child attributes

results.meta.created

string<date-time>

results.meta.modified

string<date-time>

results.meta.last_active

string<date-time>

results.meta.last_passkey_registration_prompt

string<date-time>

results.connection_map

object

Show child attributes

results.connection_map.{key}

object

Show child attributes

results.connection_map.{key}.connection_record_id

string

results.connection_map.{key}.fields

object

Show child attributes

results.connection_map.{key}.fields.{key}

object

Show child attributes

results.connection_map.{key}.fields.{key}.in_sync

boolean

Delete a user profile Retrieve one field from a user profile

⌘I

Get Started

App-Scoped Endpoints

User-Scoped Endpoints

List user profiles

Authorizations

Path Parameters

Query Parameters

Response