Skip to content

List notification groups

Request

Retrieve a paginated list of notification groups for the account. Each group ties together related notifications for an appointment, form, or payment.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

Query
startDatestring

Start of date range filter on group creation time (createdAt). ISO 8601 format.

Example:startDate=2025-01-01T00:00:00Z
endDatestring

End of date range filter on group creation time (createdAt). ISO 8601 format.

Example:endDate=2025-01-31T23:59:59Z
cursorstring

Pagination cursor from previous response

limitinteger, (int32)

Number of results per page (1-1000)

Default:20
Example:limit=20
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/notification-group?startDate=2025-01-01T00%3A00%3A00Z&endDate=2025-01-31T23%3A59%3A59Z&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Notification groups retrieved successfully

Bodyapplication/json
groupsArray of objects(NotificationGroupDTO)

List of notification groups

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

Response
{ "groups": [ {} ], "nextCursor": "string" }