Skip to main content
POST
List integration types

Restrictions

Usage

  • Public and dedicated integrations share this type catalog; it returns no configured integration instances, settings, or keys.
  • The App Key’s api_scopes must allow integration.api:read:typeList; channel.integration scopes do not include this endpoint.
  • When orderby is omitted, types come back in console ranking order and p/limit still apply.
  • supports_api_create tells you which types POST /integration/create accepts.
  • category values are not validated; an unknown value returns an empty list.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Filter parameters for listing integration types.

p
integer
default:1

Page number, 1-based.

Required range: x >= 1
limit
integer
default:20

Page size. Defaults to 20, maximum 100.

Required range: 1 <= x <= 100
orderby
enum<string>

Sort field. When omitted, types are returned in console ranking order.

Available options:
id,
created_at,
updated_at,
name,
type
category
string

Comma-separated category filter. Values: event.alert (alert events), event.change (change events), im (IM bots), webhook (custom webhooks). Unknown values are not rejected and match nothing.

asc
boolean | null
default:true

Sort ascending when true (the default); descending when false.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

A page of integration types.