Skip to content
RelayDocumentation

API ReferenceEndpoints

List endpoints

Return your endpoints, newest first.

GET/v1/endpoints

Query parameters

statusstring
One of enabled, paused or disabled.
metadata[key]string
Filter by a metadata value, e.g. metadata[customer_id]=cus_77.
created_afterstring
ISO 8601 timestamp.
limitintegerdefault: 20

Request

curl -G https://api.relay.dev/v1/endpoints \
  -H "Authorization: Bearer $RELAY_API_KEY" \
  -d "metadata[customer_id]=cus_77"

Response

200 OK
{
  "object": "list",
  "data": [
    {
      "id": "ep_2kq8XcV1",
      "object": "endpoint",
      "url": "https://api.acme.com/webhooks",
      "events": ["invoice.*"],
      "status": "enabled",
      "success_rate_24h": 0.998
    }
  ],
  "has_more": false
}