registercheckby openlaw group
API referenceDestinations

List destinations

GET
/destinations

Where your notifications are sent, oldest first.

A disabled destination is still listed, with disabled: true. Removing a destination disables it rather than deleting it — the record of where something was sent is kept — so a list that hid disabled destinations would make a removal look like a disappearance and leave no way to turn one back on.

disabled_reason says why a destination is off: disabled through the API by the customer when you disabled it, or our reason when we disabled it after repeated delivery failures. Turning it back on clears it. usable: false means the stored address cannot be delivered to at all; such destinations are listed on purpose, because they are the ones worth deleting.

Replaces GET /notification-endpoints, which answers 410.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer rc_prod_….

In: header

Query Parameters

limit?integer

Page size, 1 to 100.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor of the previous page; leave it out for the first page. Opaque: pass it back as it came. A cursor from another list, or from the same list with other filters, answers 400 validation_failed naming cursor.

Length1 <= length <= 2000

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.registercheck.de/v1/destinations" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY"
{  "object": "page",  "next_cursor": null,  "data": [    {      "object": "destination",      "id": "dst_6hq30w96je9rnrmw1tknzhwb2n",      "channel": "webhook",      "address": "https://example.com/webhooks/registercheck",      "cadence": "instant",      "role": "own",      "disabled": false,      "disabled_at": null,      "disabled_reason": null,      "usable": true,      "unusable_reason": null,      "requires_plan": null,      "metadata": {        "crm_id": "0015g00000XyZ"      },      "created_at": "2024-05-20T08:15:00Z",      "updated_at": "2024-05-20T08:15:00Z",      "enabled_events": [        "delivery"      ]    },    {      "object": "destination",      "id": "dst_4m8xq2wpv7r3t6nyk9c1bd5hza",      "channel": "email",      "address": "ops@example.com",      "cadence": "daily",      "role": "own",      "disabled": false,      "disabled_at": null,      "disabled_reason": null,      "usable": true,      "unusable_reason": null,      "requires_plan": null,      "metadata": {},      "created_at": "2024-06-10T11:30:00Z",      "updated_at": "2024-06-10T11:30:00Z",      "enabled_events": [        "delivery"      ]    }  ]}