groups

List group members

Members of a group, each as its account view plus the MEMBERSHIP: membership.role (member | manager), membership.joined_at and membership.added_by (null for system grants and memberships older than the field). role filters by membership role (400 invalid_role on any other value); joined_from/joined_to bound joined_at (YYYY-MM-DD = whole UTC day, or RFC3339; 400 on malformed); sort is name (default) | name_desc | joined | joined_desc, ties broken by account id. Peer contact fields are redacted unless the caller holds an admin-read grant.

get/groups/{id}/members

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/groups/{id}/members
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Path parameters

idstring required

id

Query parameters

qstring

search members by username / first / last name (and email, for admin-read callers)

role'member' | 'manager'

membership role

joined_fromstring

joined at or after (YYYY-MM-DD or RFC3339)

joined_tostring

joined before (YYYY-MM-DD = through that whole day, or RFC3339)

sort'name' | 'name_desc' | 'joined' | 'joined_desc'

order; unknown values fall back to name

limitinteger

page size

offsetinteger

page offset

Response

OK

limitinteger
offsetinteger
successboolean
totalinteger

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.