Skip to main content
GET
Get Tap Groups

Authorizations

x-client-id
string
header
required

Client ID for API authentication

x-api-key
string
header
required

API Key for API authentication

Query Parameters

limit
number
default:25

The number of tap groups to return.

Required range: 1 <= x <= 100
page
number
default:1

The page number of the tap groups to return.

Required range: x >= 1

Search tap groups by name.

Example:

"Sunday Service"

includeArchived
boolean

Whether to include tap groups that have been archived.

sortBy
enum<string>
default:createdAt

The field to sort the tap groups by.

Available options:
name,
createdAt
Example:

"createdAt"

sortDirection
enum<string>
default:DESC

The direction to sort the tap groups by.

Available options:
ASC,
DESC
Example:

"DESC"

Response

200 - application/json
data
object[]
required

List of tap groups.

totalCount
number
required

Total number of tap groups matching the filters.

Example:

100

Last modified on July 14, 2026