Skip to Content
eventdoordocs home

List organization hubs

GET
/organizations/{orgSlug}/hubs

Filter by tag categories using query params named after category slugs (e.g. ?age_group=5-8,9-12&sport=swimming). Within a category, values are OR'd; across categories, they are AND'd. Also supports single-value tag / collection / category filters. Use facets=true to include facet counts in the response.

Authorization

ApiCredential
headerAuthorizationBearer <edk_<id>_<secret>>

A scoped API credential (edk_...), issued in the admin under Settings > Integrations and sent as Authorization: Bearer edk_.... Its level, scope and refusals are in Authentication; its rate limit and the 429 response are in Errors.

Path Parameters

orgSlug*string

Query Parameters

limit?|

Maximum number of items to retrieve per page. Use "all" to retrieve all items without pagination.

cursor?string

Opaque cursor for pagination

query?string

Search hubs by name

Lengthlength <= 72
parentId?string

Filter by parent hub ID. Use "root" for top-level hubs only.

facets?"true"

Set to "true" to include facet counts in the response

Value in"true"
state?string

Filter hubs by temporal state. "upcoming" returns hubs whose starts_at is in the future. "active" returns hubs currently in progress (starts_at <= now and ends_at is null or in the future). "past" returns hubs whose ends_at is in the past.

Value in"upcoming""active""past"
startsAfter?string

Filter to items starting at or after this date-time.

Formatdate-time
startsBefore?string

Filter to items starting at or before this date-time.

Formatdate-time
endsAfter?string

Filter to items ending at or after this date-time.

Formatdate-time
endsBefore?string

Filter to items ending at or before this date-time.

Formatdate-time
tag?string

Filter by tag slug.

tagCategory?string

Filter by tag-category slug.

collection?string

Filter by collection slug.

collectionCategory?string

Filter by collection-category slug.

collectionItem?string

Filter by collection-item id (UUID).

Formatuuid

Response Body

Successful operation

application/json
  1. response
hubs?array<>
total?integer
paging?
facets?array<>
Example Request
curl -X GET "$EVENTDOOR_API/organizations/acme/hubs" \
  -H "Authorization: Bearer $EVENTDOOR_TOKEN"
Example Response
{
  "hubs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",
      "name": "string",
      "slug": "string",
      "description": "string",
      "avatarUrl": "string",
      "bannerUrl": "string",
      "posterUrl": "string",
      "location": "string",
      "startsAt": "2019-08-24T14:15:22Z",
      "endsAt": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "allDay": true,
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "slug": "string",
        "name": "string",
        "avatarUrl": "string"
      },
      "tags": [
        {
          "category": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "slug": "string",
            "name": "string"
          },
          "values": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "slug": "string",
              "label": "string"
            }
          ]
        }
      ],
      "childrenCount": 0,
      "children": [
        {}
      ],
      "gate": {
        "tier": "free",
        "origin": "direct",
        "gatedContentType": "broadcast",
        "gatedContentId": "6a2155c7-3a80-4718-80d0-2c42044f9b75",
        "label": "string",
        "buttonLabel": "string",
        "showPrice": true,
        "unitAmount": 0,
        "currency": "string",
        "recurringInterval": "day"
      },
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z"
    }
  ],
  "total": 0,
  "paging": {
    "next": "string",
    "hasMore": true
  },
  "facets": [
    {
      "categorySlug": "string",
      "categoryName": "string",
      "values": [
        {
          "slug": "string",
          "label": "string",
          "count": 0
        }
      ]
    }
  ]
}