Skip to main content
GET
/
api
/
v3
/
tap
/
groups
Get Tap Groups
curl --request GET \
  --url https://server.stage.overflow.co/api/v3/tap/groups \
  --header 'x-api-key: <api-key>' \
  --header 'x-client-id: <api-key>'
{
  "data": [
    {
      "id": "6710f34fd5061afeec3eab58",
      "name": "Sunday Service Group",
      "destinationId": "6710f34fd5061afeec3eab57",
      "destination": {
        "id": "6710f34fd5061afeec3eab57",
        "name": "Main Giving Page",
        "type": "web",
        "url": "https://example.com/give",
        "textNumber": null,
        "textContent": null
      },
      "deviceIds": [
        "6710f34fd5061afeec3eab59"
      ],
      "createdAt": "2026-05-01T17:22:11.421Z",
      "updatedAt": "2026-05-04T14:09:32.145Z",
      "archivedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalCount": 100
}

Documentation Index

Fetch the complete documentation index at: https://docs.overflow.co/llms.txt

Use this file to discover all available pages before exploring further.

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
string

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