List applications

GET

/v1/applications

curl --request GET \
  --url 'https://api.hooks.events/v1/applications?status=active' \
  --header 'Authorization: Bearer <token>'

• Production

Requires the endpoints:read scope.

Authorizations

• apiKey
• sessionCookie

Parameters

Query Parameters

cursor

string

Cursor from a previous nextCursor

limit

integer

>= 1 <= 100

Page size, 1–100 (default 20)

status

string

Allowed values: active archived

Responses

200

Success

Media typeapplication/json

object

data

required

Array<object>

Tenant application (one end customer)

object

id

required

Resource id

string

uid

required

Customer-side identifier, unique per workspace

string | null

name

required

string

brandColor

required

Portal accent color

string

customDomain

required

Customer hostname that fronts the portal

string | null

status

required

string

Allowed values: active archived

endpointId

required

Backing endpoint that receives the application’s messages

string

ingestUrl

required

Public URL of the backing endpoint

string

createdAt

required

ISO-8601 timestamp

string

updatedAt

required

ISO-8601 timestamp

string

key

additional properties

nextCursor

required

Pass as ?cursor= to fetch the next page

string | null

key

additional properties

Example

{
  "data": [
    {
      "status": "active"
    }
  ]
}

400

Validation error

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

401

Missing or invalid credentials

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

403

The credential lacks the required scope, or the workspace is not writable

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

429

Rate limited

Media typeapplication/json

object

error

required

object

code

required

Machine-readable error code

string

message

required

string

requestId

required

Request id, also echoed in x-request-id

string

key

additional properties

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "requestId": "example"
  }
}

Headers

X-RateLimit-Limit

integer

Requests allowed per window

X-RateLimit-Remaining

integer

X-RateLimit-Reset

integer

Seconds until the window resets