v1

latestOpenAPI 3.0.02026-07-2641142112.7 KB

Endpoint

List Endpoints

List the application's endpoints.

get/endpoint

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

prevIteratorstring nullable

doneboolean required

Example response

{
  "data": [
    {
      "id": "ep_1srOrx2ZWZBpBUvZwXKQmoEYga2",
      "uid": "unique-ep-identifier",
      "url": "https://example.com/webhook/",
      "version": 1,
      "filterTypes": [
        "shipment.added.to.endpoint",
        "container.new.event.detected"
      ],
      "channels": [
        "project_123",
        "group_2"
      ],
      "createdAt": "2024-01-12T14:43:13.993727Z",
      "updatedAt": "2024-01-12T14:43:13.993727Z"
    }
  ],
  "iterator": "iterator",
  "prevIterator": "-iterator"
}