Tenants

Retrieves details for a specific tenant.

get/tenants/{tenant_id}

Request

  • Base URL
    https://api.outpost.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP bearer

Response

Tenant details.

idstring

User-defined system ID for the tenant.

destinations_countinteger

Number of destinations associated with the tenant.

topicsstring[]

List of subscribed topics across all destinations for this tenant.

metadataobject nullable

Arbitrary key-value pairs for storing contextual information about the tenant.

created_atstring date-time

ISO Date when the tenant was created.

updated_atstring date-time

ISO Date when the tenant was last updated.

Example response

{
  "id": "123",
  "destinations_count": 5,
  "topics": [
    "user.created",
    "user.deleted"
  ],
  "metadata": {
    "name": "Acme Inc."
  },
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Changes

    • info

      added the non-success response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status