GET /v1/outcomes

Family: Feedback and providers · Operation ID: v1_list_outcomes

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open outcomes and provider setup

Required scope: suppressions

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X GET "$API_BASE_URL/v1/outcomes" \
  -H "Authorization: Bearer $API_KEY"

Parameters

[
  {
    "in": "query",
    "name": "limit",
    "required": false,
    "schema": {
      "format": "int64",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "offset",
    "required": false,
    "schema": {
      "format": "int64",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "email",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "event_type",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "source_key",
    "required": false,
    "schema": {
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "since",
    "required": false,
    "schema": {
      "format": "date-time",
      "type": "string"
    }
  }
]

Responses

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OutcomeListResponse"
      }
    }
  },
  "description": "Paginated provider outcomes"
}

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract