List group invites

GET

applications

{app}

groups

{group}

invites

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

{
  "total_results": 123,
  "results": [
    {
      "id": "c92kd7td7z4myhu7z5y637cp",
      "group_id": "group_zjca79svvbqfeilwr8httcal",
      "roles": [
        "editor"
      ],
      "state": "pending",
      "email": "randy@foo.com",
      "phone": 19199993333,
      "user_id": "user_mni5316glfgwtgljboxrv2it",
      "user_lookup_value": "randy@foo.com",
      "redirect_url": "/somewhere/on/my/site#",
      "app_variant_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "user_t6ftnnmw55pamuhfo9xvw0yl",
      "accepted_by": "user_vgzrk03xpenj6td8vwi9crh4",
      "ensured_user_id": "<string>"
    }
  ]
}

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

group

string

required

Group ID

Query Parameters

ensured_user_id

string

The User ID for which the invite was created. This is not the member ID

Response

200 - application/json

Groups retrieved successfully

total_results

integer

results

object[]

results.roles

string[]

required

The roles into which a group member will be added upon invite acceptance (The first member invited to a group will always be created with the 'owner' role along with any additional roles specified)

Example:

["editor"]

results.id

string

The group invite ID

Example:

"c92kd7td7z4myhu7z5y637cp"

results.group_id

string

The group ID

Example:

"group_zjca79svvbqfeilwr8httcal"

results.state

enum<string>

The state of the invite

Available options:

pending,

accepted,

rejected

results.email

string

The email of a Rownd user in the specified application. This property is mutually exclusive with user_id and email

Example:

"randy@foo.com"

results.phone

string

The phone number of a Rownd user in the specified application. This property is mutually exclusive with user_id and email

Example:

19199993333

results.user_id

string

The ID of a Rownd user in the specified application. This property is mutually exclusive with phone and email

Example:

"user_mni5316glfgwtgljboxrv2it"

results.user_lookup_value

string

The email or phone number specified during creation

Example:

"randy@foo.com"

results.redirect_url

string

The relative or absolute path location to which a user will be directed after accepting the invite

Example:

"/somewhere/on/my/site#"

results.app_variant_id

string

The ID of an application variant for which this invite should be created. When a user accepts this invite, they will be added to the group as a member and signed into this application variant. (Learn about variants here)

results.created_at

string

The ISO 8601 date-time that the resource was created

results.created_by

string

The ID of the user that created the resource

Example:

"user_t6ftnnmw55pamuhfo9xvw0yl"

results.accepted_by

string

The ID of the user that accepted the invite

Example:

"user_vgzrk03xpenj6td8vwi9crh4"

results.ensured_user_id

string

The ID of the user ensured by the provided user_id or user_lookup_value

Delete a group invite Create a group member

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

{
  "total_results": 123,
  "results": [
    {
      "id": "c92kd7td7z4myhu7z5y637cp",
      "group_id": "group_zjca79svvbqfeilwr8httcal",
      "roles": [
        "editor"
      ],
      "state": "pending",
      "email": "randy@foo.com",
      "phone": 19199993333,
      "user_id": "user_mni5316glfgwtgljboxrv2it",
      "user_lookup_value": "randy@foo.com",
      "redirect_url": "/somewhere/on/my/site#",
      "app_variant_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "user_t6ftnnmw55pamuhfo9xvw0yl",
      "accepted_by": "user_vgzrk03xpenj6td8vwi9crh4",
      "ensured_user_id": "<string>"
    }
  ]
}

Get Started

App-Scoped Endpoints

User-Scoped Endpoints

List group invites

Authorizations

Path Parameters

Query Parameters

Response