---
title: "Get a list of access groups"
method: GET
path: "/access-groups"
tags: ["Access Group"]
---

# Get a list of access groups

`GET /access-groups`

The ability to list all access groups for the customer

## Query parameters

- `ids` string[] — ID of access group(s) to fetch
- `types` string[] — Access group types
- `statuses` string[] — Access group statuses
- `typeIds` string[] — Ids of the entity implied by the type(s), e.g. the partner ID
- `accountIds` string[] — Account BIDs of access groups to fetch
- `accountIdSearchCriteria.matchMode` 'ALL' | 'ANY'
- `accountIdSearchCriteria.value` object

## Response `200`

OK

- AccountAccessGroupResponse[]
  - `id` string — Unique ID for the access group
  - `name` string — Access group name
  - `type` 'SERVICE_PARTNER' | 'SERVICE_CUSTOMER' | 'DELEGATE' | 'USER_DEFINED' — The type of access group
  - `typeId` string — The identifier of the linked entity implied by the type, e.g. the partner ID
  - `status` 'ACTIVE' | 'DELETED' — Status of the access group
  - `countOfAccounts` integer — The number of accounts in this group

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/modulrfinance/apis/modulr-api.md) · [All operations](https://skmtc.net/modulrfinance/apis/modulr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modulrfinance/modulr-api/revisions/cbd52524c8ef/schema)