GET/v1/integrations/apps

Integration apps

The registry as it applies to the organisation: apps with their status (ACTIVE to install, COMING_SOON, NOT_IN_PLAN when another plan offers it, WITHDRAWN when no new installations are possible but the organisation has one), capabilities and configuration fields.

Scope integrations.read

Returns

6 fields of the 200 answer

keystringrequired

namestringrequired

descriptionstringrequired

statusenumrequired

ACTIVECOMING_SOONNOT_IN_PLANWITHDRAWN

capabilitiesarray of enumrequired

outboundinbound

fieldsarray of objectsrequired

7 fields

keystringrequired

labelstringrequired

typeenumrequired

urlstringbooleanselect

requiredboolean

secretboolean

optionsarray of string

hintstring

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/integrations/apps \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.integrations.apps();

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.integrations.apps()

Response

[
  {
    "key": "first_name",
    "name": "Welcome card",
    "description": "Welcome card for new customers",
    "status": "ACTIVE",
    "capabilities": [
      "outbound"
    ],
    "fields": [
      {
        "key": "first_name",
        "label": "First name",
        "type": "url",
        "required": false,
        "secret": false,
        "options": [
          "Example"
        ],
        "hint": "Example"
      }
    ]
  }
]