For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

List groups

このページはまだあなたの言語に翻訳されていません。 現在取り組んでいますので、後でもう一度確認してください。

Returns a paginated list of permission groups for the caller's organization. Soft-deleted groups are omitted.

get/user-management/1/groups

Authorizations

Authorizationstringrequired

Contact Amplitude Support to obtain your organization's org API key and org secret key.Send them as HTTP Basic credentials on every request: org API key in the username field, org secret key in the password field. Also include orgId as a query parameter for your organization.401: invalid credentials. 403 (org_not_enrolled): your organization is not enabled for this API.

Query parameters

orgIdintegerrequired

Organization id for the authenticated API caller. Must match the organization tied to the org key pair in the Authorization header.

Constraints:min: 1
cursorstring

Opaque pagination cursor from a previous response pagination.nextCursor. Omit to start at the first page.

limitinteger

Maximum number of items per page. Defaults to 50 when omitted and is capped at 200.

Constraints:min: 1max: 200

Response

application/json
200· Groups found
dataobject[]required
Show child attributes
groupIdintegerrequired
Constraints:min: 0
namestringrequired
orgIdinteger
Constraints:min: 0
descriptionstring
paginationobjectrequired

Cursor pagination metadata. nextCursor is the cursor to pass to fetch the next page, or null when there are no more results. hasMore indicates whether another page is available.

Example:{"nextCursor":0,"hasMore":true}
Show child attributes
nextCursorstringrequired
Constraints:nullable
hasMorebooleanrequired
400· Invalid request parameters or body
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
401· Missing or invalid credentials
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
403· Not allowed (org not enrolled, orgId mismatch, or insufficient permissions)
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
429· Rate limit exceeded
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable
500· Unexpected server error
typestringrequired

RFC 7807 problem type URI

Constraints:format: uri
titlestringrequired
statusintegerrequired
detailstring
Constraints:nullable
instancestring
Constraints:nullable
error_codestringrequired
Allowed values:invalid_requestauthentication_requiredinsufficient_permissionsorg_id_mismatchorg_not_enrollednot_foundconflictrate_limitedinternal_error
retryablebooleanrequired
retry_after_secondsinteger
Constraints:nullable

これは役に立ちましたか？