Skip to content
/User Groups

User Groups

API for reading user groups

Operations

List user groups

Request

Lists the user groups of the organization behind the API credential, ordered by name. Pass the returned id values in the user_group_ids field of POST /users.

Platform partners can list a connected organization's groups by sending that organization's account id in the Onboarded-Connected-Account-Id header.

User groups belong to an organization rather than to an account, so a test key and a live key for the same organization return the same groups with the same identifiers.

Security
form_session or user_session or component_session or component_token or api_token
Query
pagestring(page)

1-based page number. There is no upper bound; values below 1 are clamped to 1.

per_pagestring(between(1, 100))

a number between 1 and 100

namestring

Case-insensitive substring match on the group name. admin matches Admins.

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/user_groups?page=string&per_page=string&name=string' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>'

Responses

Success

Bodyapplication/json
dataArray of objects(UserGroup)required
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}