GET
/
v1
/
consumers
/
postgres
curl --request GET \
  --url https://api.sequin.io/v1/consumers/postgres \
  --header 'Authorization: Bearer <token>'
"data": [
  {
    "id": "00000582-47fb-422e-8a79-da12502ccc63",
    "name": "consume-stripe-collections",
    "active": true,
    "syncs": ["446e3f05-6021-48f5-8c28-ec7e1fa9e944"], // or ["*"] for all syncs
    "target_id": "6c4ecaaa-b62a-4cf8-aa99-8f00e2ec3d1a",
    "health": {
      "status": "ok",
      "notes": [],
      "time": "2023-12-15 01:29:29"
    },
    "metadata": { "custom_property": 42 },
    "created_at": "2023-12-15 01:29:29",
    "updated_at": "2023-12-15 01:29:29"
  },
  { ... },
  { ... }
]

Request parameters

sync_id
string
required

Filter for Postgres consumers for this sync.

target_id
string

Filter for Postgres consumers for this target.

active
boolean

Filter for Postgres consumers that are active or inactive.

metadata
object

Filter for Postgres consumers matching the properties supplied in this map. For example, {"custom_property": 42} will return all syncs with a custom_property of 42.

Response fields