Skip to Content
eventdoordocs home

Get hub

GET
/organizations/{orgSlug}/hubs/{hubSlug}

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
hubSlug*string

Query Parameters

expand?"tree"

Set to "tree" to include nested children

Value in"tree"
depth?integer

Max nesting depth when expand=tree (default 2, max 5)

Range1 <= value <= 5
Default2

Response Body

Successful operation

application/json
  1. response
id*string
Formatuuid
organizationId*string
Formatuuid
parentId?|
Formatuuid
name*string
slug*string
description?string|null
avatarUrl?string|null
bannerUrl?string|null
posterUrl?string|null
location?string|null
startsAt?|
Formatdate-time
endsAt?|
Formatdate-time
timezone?string|null
allDay?boolean
organization?
tags?array<>
childrenCount?integer
children?array<>
gate?|null

PUBLIC monetization badge. Null when the hub is free / ungated. Present on list responses; single-hub responses omit it. Carries no viewer entitlement data.

created?string
Formatdate-time
updated?string
Formatdate-time
Example Request
curl -X GET "$EVENTDOOR_API/organizations/acme/hubs/home-games" \
  -H "Authorization: Bearer $EVENTDOOR_TOKEN"
Example Response
{
  "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"
}