Sign in

v1

latestOpenAPI 3.1.0© Modulr Finance2026-08-04207430590.4 KB
Access Group

Get access group

The ability to retrieve an access group by ID

get/access-groups/{accessGroupId}

Path parameters

accessGroupIdstring required

Access group ID

Response

OK

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

accountIdsstring[]

BIDs of Accounts in the group

beneficiaryIdsstring[]

BIDs of Beneficiaries in the group

Example response

{
  "id": "G0000001"
}