v2

latestOpenAPI 3.1.02026-07-312303692.4 MB

Endpoint

List Endpoints

List the application's endpoints.

get/api/v1/app/{app_id}/endpoint

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

The Application's ID or UID.

Query parameters

limitinteger

Limit the number of returned items

iteratorstring nullable

The iterator returned from a prior invocation

Example:ep_1srOrx2ZWZBpBUvZwXKQmoEYga2

The iterator returned from a prior invocation

order'ascending' | 'descending'

Defines the ordering in a listing of results.

The sorting order of the returned items

Response

iteratorstring nullable required

prevIteratorstring nullable

doneboolean required

Example response

{
  "data": [
    {
      "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "url": "https://example.com/webhook/",
      "uid": "unique-identifier",
      "version": 1,
      "filterTypes": [
        "user.signup",
        "user.deleted"
      ],
      "channels": [
        "project_123",
        "group_2"
      ]
    }
  ],
  "iterator": "iterator",
  "prevIterator": "-iterator"
}