- Blog
- Contact Us
Authentication
Magic Links
User Profiles
Groups
Group Invitations
Group Members
User Profiles
Groups
Group Invitations
Group Members
Get Started
App-Scoped Endpoints
User-Scoped Endpoints
List groups
User-facing API for listing groups
Bearer authentication header of the form Bearer <token> where <token> is the user's Rownd JWT
curl --request GET \
--url https://api.rownd.io/me/groups \
--header 'Authorization: Bearer <token>'{
"total_results": 123,
"results": [
{
"group": {
"id": "group_a3l1n2lsnb3q0xbul9enjnh7",
"name": "My Teammates",
"member_count": 123,
"app_id": "327677849595019856",
"admission_policy": "invite_only",
"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"
}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token> where <token> is the user's Rownd JWT
Response
The group
The group ID
The group name
This value is no longer provided by the API. The default value of 0 will always be returned
Rownd application ID
Set whether the group be open for anyone to join or by invite only
invite_only, open 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
The ID of the user that most recently updated the resource
The group member
The group member ID
The ID of a user to add as a group member. The user must belong to the Rownd application.
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)
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
curl --request GET \
--url https://api.rownd.io/me/groups \
--header 'Authorization: Bearer <token>'{
"total_results": 123,
"results": [
{
"group": {
"id": "group_a3l1n2lsnb3q0xbul9enjnh7",
"name": "My Teammates",
"member_count": 123,
"app_id": "327677849595019856",
"admission_policy": "invite_only",
"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"
}
}
]
}