Members

Lists members of a team and their permissions.

Lists members of a team and their permissions. Callers that are not a team admin will see all members, but project roles and team admin status will only be provided for the caller identity.

get/api/v2/members

Request

  • Base URL: https://uniform.app
  • URL: https://uniform.app/api/v2/members
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

teamIdstring required
type'member' | 'apiKey' | 'pat' | 'serviceAccount' | 'automation'

Filter by member type: member (oauth login), apiKey (all API keys), pat (PATs only), serviceAccount (service accounts only), automation (automation machine identities)

ownerSubjectstring

Filter PATs by owner subject. Requires type=pat. Returns only PATs owned by this user.

subjectstring

Filter to a specific member by subject. Useful for fetching a single member.

keywordstring

Search keyword to filter members by name or email (case-insensitive).

offsetinteger nullable

Number of records to skip for pagination. Defaults to 0.

limitinteger

Maximum number of records to return. Maximum 1000 when specified, but no limit is used when unspecified.

includeMetadataboolean nullable

Includes additional metadata with member info, specifically created timestamp and project names.

includeProjectsboolean nullable

Includes project and role assignments for each member. Required to see role information.

includeCustomPermissionsboolean nullable

Includes custom permissions for each member (deprecated feature). Requires includeProjects to be true.

withTotalCountboolean nullable

When true, includes totalCount in the response for pagination. May add slight overhead.

orderBy'name_ASC' | 'name_DESC' | 'email_ASC' | 'email_DESC' | 'created_ASC' | 'created_DESC'

Sort order for results. Defaults to name_ASC.

Response

Members list retrieved successfully

totalCountnumber

Total number of members matching the query. Only present if withTotalCount is true.

Changes

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