---
title: "AuthorisationGroup:Browse"
method: GET
path: "/v2/authorisationgroups"
tags: ["AuthorisationGroup"]
---

# AuthorisationGroup:Browse

`GET /v2/authorisationgroups`

Get all AuthorisationGroups that are applicable and configured. You can use the AuthorisationGroup code (the AG-code) to give an account specific rights in e.g. the Merchants:Create API. If you have the appropriate rights you can also create your own custom authorisation groups

## Query parameters

- `page` integer
- `limit` integer
- `purpose` object
  - `eq` string — Get results that equal the given value
  - `neq` string — Get results that do not equal the given value
  - `in` string — Get results that match any of the given purposes (comma-separated)
- `type` object
  - `eq` string — Filter authorisation groups by type.

## Response `200`

The Authorisation Groups.

- AuthorisationGroupAuthorisationGroupsOutput
  - `authorisationGroups` AuthorisationGroupAuthorisationGroupOutput[] — Collection of AuthorisationGroup.AuthorisationGroupOutput objects or an empty array.
    - `code` string — The code of the authorisation group.
    - `name` string — Name of the authorisation group.
    - `description` string — Description of the authorisation group.
    - `type` 'package' | 'right' | 'module' — Type of authorisation group. Valid values are right, module, and package. Defaults to right when omitted.
    - `requiredAuthorisationGroup` string, nullable — AG-code of the authorisation group that is required before this authorisation group can be enabled.
    - `linkedProfileCode` string, nullable — CP-code of the linked company profile.
    - `purpose` AuthorisationGroupAuthorisationGroupPurposeOutput
      - `account` boolean — Indicates whether this authorisation group can be assigned to an account.
      - `merchant` boolean — Indicates whether this authorisation group can be assigned to a merchant.
      - `token` boolean — Indicates whether this authorisation group can be assigned to an authentication token.
      - `relation` boolean — Indicates whether this authorisation group can be assigned to a merchant connection.
    - `public` boolean — Indicate if the authorisation group is public.
    - `translations` object — Object containing translations for the authorisation group fields.
    - `authorisationObjects` AuthorisationGroupAuthorisationObjectOutput[] — Array of authorisation objects linked through the authorisation group.
      - `code` string — The unique identifier of the authorisation object.
      - `name` string — Name of the authorisation object.
      - `translations` object — Object containing translations for the authorisation object fields.
    - `createdAt` string, date-time, nullable — The date and time at which this entity was created in ISO-8601 (ATOM) notation
    - `createdBy` string, nullable — The reference to an account or token whom created the entity
    - `modifiedAt` string, date-time, nullable — The date and time at which this entity was modified in ISO-8601 (ATOM) notation.
    - `modifiedBy` string, nullable — The reference to an account or token whom modified this entity
    - `deletedAt` string, date-time, nullable — The date and time at which this entity was deleted in ISO-8601 (ATOM) notation.
    - `deletedBy` string, nullable — The reference to an account or token whom deleted the entity
    - `_links` LinkOutput[], nullable
      - `href` string, nullable — The URI to the linked resource
      - `rel` string, nullable — The name of the linked resource
      - `type` string, nullable — The (http(s)) method needed to approach the linked resource
  - `count` integer — The amount of items the collection contains
  - `pages` integer — The amount of pages available
  - `total` integer, nullable — The total items the collection contains
  - `_links` LinkOutput[], nullable
    - `href` string, nullable — The URI to the linked resource
    - `rel` string, nullable — The name of the linked resource
    - `type` string, nullable — The (http(s)) method needed to approach the linked resource

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `404` — Resource not found
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `410` — Indicates that this resource is no longer available for use
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `429` — Rate limit reached.
- `500` — An internal error occurred.
- `503` — The server is currently unable to handle your request

---

[API](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/versions/2bc260c7bdfc/schema)