List portal tokens

GET

/v1/applications/{id}/portal-tokens

curl --request GET \
  --url https://api.hooks.events/v1/applications/example/portal-tokens \
  --header 'Authorization: Bearer <token>'

• Production

Requires the endpoints:read scope.

Authorizations

• apiKey
• sessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Success

Media typeapplication/json

object

data

required

Array<object>

Short-lived portal capability; the plaintext token is returned once

object

id

required

Resource id

string

applicationId

required

string

name

required

Label shown in the workspace, e.g. an email

string | null

tokenPrefix

required

First characters of the token, for recognition

string

expiresAt

required

ISO-8601 timestamp

string

lastUsedAt

required

Any of:

string

ISO-8601 timestamp

string

null

null

revokedAt

required

Any of:

string

ISO-8601 timestamp

string

null

null

createdAt

required

ISO-8601 timestamp

string

key

additional properties

key

additional properties

Example ^generated

{
  "data": [
    {
      "id": "example",
      "applicationId": "example",
      "name": "example",
      "tokenPrefix": "example",
      "expiresAt": "example",
      "lastUsedAt": "example",
      "revokedAt": "example",
      "createdAt": "example"
    }
  ]
}

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"
  }
}

404

Resource not found

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