v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB

Access Group

Get a list of access groups

The ability to list all access groups for the customer

get/access-groups

idsstring[]

ID of access group(s) to fetch

[
  "G0000001"
]

typesstring[]

Access group types

statusesstring[]

Access group statuses

typeIdsstring[]

Ids of the entity implied by the type(s), e.g. the partner ID

[
  "C0000001"
]

accountIdsstring[]

Account BIDs of access groups to fetch

[
  "A0000001"
]

accountIdSearchCriteria.matchMode'ALL' | 'ANY'

accountIdSearchCriteria.valueobject

idstring

Unique ID for the access group

namestring

Access group name

type'SERVICE_PARTNER' | 'SERVICE_CUSTOMER' | 'DELEGATE' | 'USER_DEFINED'

The type of access group

typeIdstring

The identifier of the linked entity implied by the type, e.g. the partner ID

status'ACTIVE' | 'DELETED'

Status of the access group

countOfAccountsinteger

The number of accounts in this group

[
  {
    "id": "G0000001"
  }
]