---
title: "List catalog entities."
method: GET
path: "/v1/entities"
tags: ["Catalog"]
---

# List catalog entities.

`GET /v1/entities`

## Request

- Base URL: `https://api.sourcey.com`
- URL: `https://api.sourcey.com/v1/entities`
- Auth: one of:
  - none
  - HTTP bearer

## Query parameters

- `category` string
- `cursor` string
- `domain` string
- `limit` integer
- `q` string, required

## Response `200`

Successful response.

- ListEntitiesResponse200
  - `api_contract` 'sourcey.catalog-api/v1', required
  - `artifact_sha256` string, required
  - `assets` object[], required
    - `approval_receipt_digest` string, required
    - `asset_object_digest` string, required
    - `authority_basis` 'vendor-authority' | 'editorial-review' | 'licensed-source' | 'sourcey-owned', required
    - `authority_claim_id` string
    - `binding_event_id` string, required
    - `bytes` integer, required
    - `effective_from` string, date-time, required
    - `effective_until` string, date-time
    - `entity_id` string, required
    - `height` integer, required
    - `license_basis` string, required
    - `media_type` 'image/jpeg' | 'image/png' | 'image/webp' | 'image/svg+xml', required
    - `role` 'logo-light' | 'logo-dark' | 'icon', required
    - `served_digest` string, required
    - `served_path` string, starts_with, required
    - `source_basis` string, required
    - `width` integer, required
  - `category` string, nullable, required
  - `data` object[], required
    - `category` string, required
    - `description` string, required
    - `entity_id` string, required
    - `identity_assurance` object
      - `assurance_id` string, required
      - `coverage_policy_digest` string, required
      - `event_id` string, required
      - `identity_epoch_digest` string, required
      - `method_policy_digest` string, required
      - `receipt_digest` string, required
      - `status` 'verified', required
      - `verified_at` string, date-time, required
    - `name` string, required
    - `offers` object[], required
      - `access` object, required
        - `availability` 'public' | 'referral' | 'membership' | 'invite' | 'automatic' | 'other', required
        - `instructions` string
        - `method` 'form' | 'code' | 'contact' | 'automatic' | 'other', required
        - `public_code` string
        - `url` string, uri
      - `description` string
      - `economics` object, required
        - `benefits` union[], required
          - union
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
            - object
              - …
        - `consideration` union, required
          - object
            - `kind` 'none', required
          - object
            - `amount` object, required
              - …
            - `kind` 'fixed', required
          - object
            - `description` string, required
            - `kind` 'variable', required
          - object
            - `description` string, required
            - `kind` 'unknown', required
      - `effective_from` string, date-time, required
      - `effective_until` string, date-time
      - `eligibility` object, required
        - `rule` Schema0, required (unresolved $ref)
      - `headline` object
        - `basis` 'typed' | 'described', required
        - `benefit_id` string, required
        - `figure` union, required
          - object
            - `duration` union
              - …
            - `kind` 'credit', required
            - `value` union, required
              - …
          - object
            - `applies_to` string
            - `duration` union
              - …
            - `kind` 'discount', required
            - `percentage` union, required
              - …
          - object
            - `duration` union
              - …
            - `kind` 'cashback', required
            - `value` union, required
              - …
          - object
            - `duration` union, required
              - …
            - `kind` 'free-service', required
            - `service` string
          - object
            - `kind` 'waiver', required
            - `waived_item` string, required
        - `rule` 'sourcey.offer-headline/v1', required
      - `lifecycle` 'active' | 'paused' | 'ended' | 'withdrawn', required
      - `offer_id` string, required
      - `program_id` string
      - `provenance` object, required
        - `basis_event_ids` string[], required
        - `coverage_policy_digest` string, required
        - `dispute` 'none' | 'open' | 'resolved', required
        - `fields` object[], required
          - `accepted_proof_kinds` string[], required
          - `contradicting_event_ids` string[], required
          - `evidence_proof_kinds` string[], required
          - `freshness` 'fresh' | 'stale' | 'unknown', required
          - `latest_observation_at` string, date-time
          - `path` string, starts_with, required
          - `supporting_event_ids` string[], required
        - `freshness` 'fresh' | 'stale' | 'unknown', required
        - `freshness_policy_digest` string, required
        - `vendor_attestation` union, required
          - object
            - `status` 'none', required
          - object
            - `attested_at` string, date-time, required
            - `event_id` string, required
            - `status` 'current', required
      - `revision_digest` string, required
      - `roles` object, required
        - `access_operator_entity_id` string, required
        - `terms_authority_entity_id` string, required
      - `slug` string, required
      - `summary` string, required
      - `terms_assurance` object
        - `assurance_id` string, required
        - `checked_at` string, date-time, required
        - `coverage_policy_digest` string, required
        - `event_id` string, required
        - `method_policy_digest` string, required
        - `receipt_digest` string, required
        - `revision_digest` string, required
        - `status` 'checked', required
      - `terms_url` string, uri
      - `title` string, required
    - `programs` object[], required
      - `program_id` string, required
      - `provenance` object, required
        - `basis_event_ids` string[], required
        - `coverage_policy_digest` string, required
        - `dispute` 'none' | 'open' | 'resolved', required
        - `fields` object[], required
          - `accepted_proof_kinds` string[], required
          - `contradicting_event_ids` string[], required
          - `evidence_proof_kinds` string[], required
          - `freshness` 'fresh' | 'stale' | 'unknown', required
          - `latest_observation_at` string, date-time
          - `path` string, starts_with, required
          - `supporting_event_ids` string[], required
        - `freshness` 'fresh' | 'stale' | 'unknown', required
        - `freshness_policy_digest` string, required
        - `vendor_attestation` union, required
          - object
            - `status` 'none', required
          - object
            - `attested_at` string, date-time, required
            - `event_id` string, required
            - `status` 'current', required
      - `revision_digest` string, required
      - `slug` string, required
      - `summary` string
      - `title` string, required
    - `provenance` object, required
      - `basis_event_ids` string[], required
      - `coverage_policy_digest` string, required
      - `dispute` 'none' | 'open' | 'resolved', required
      - `fields` object[], required
        - `accepted_proof_kinds` string[], required
        - `contradicting_event_ids` string[], required
        - `evidence_proof_kinds` string[], required
        - `freshness` 'fresh' | 'stale' | 'unknown', required
        - `latest_observation_at` string, date-time
        - `path` string, starts_with, required
        - `supporting_event_ids` string[], required
      - `freshness` 'fresh' | 'stale' | 'unknown', required
      - `freshness_policy_digest` string, required
      - `vendor_attestation` union, required
        - object
          - `status` 'none', required
        - object
          - `attested_at` string, date-time, required
          - `event_id` string, required
          - `status` 'current', required
    - `revision_digest` string, required
    - `slug` string, required
    - `slug_aliases` string[]
    - `summary` string
    - `website` string, uri, required
  - `next_cursor` string, nullable
  - `query` string, required
  - `release_id` string, required
  - `summary` object, required
    - `active_offer_count` integer, required
    - `categories` object[], required
      - `active_offer_count` integer, required
      - `category` string, required
      - `entity_count` integer, required
      - `offer_count` integer, required
      - `program_count` integer, required
    - `entity_count` integer, required
    - `latest_observation_at` string, date-time, nullable, required
    - `offer_count` integer, required
    - `program_count` integer, required
    - `terms_checked_offer_count` integer, required
    - `vendor_confirmed_entity_count` integer, required
    - `verified_entity_count` integer, required

## Other responses

- `400`: Invalid request.
- `401`: HTTP 401 response.
- `403`: HTTP 403 response.
- `405`: HTTP 405 response.
- `429`: HTTP 429 response.
- `500`: HTTP 500 response.
- `503`: HTTP 503 response.

---

[API](https://skmtc.dev/sourcey/apis/sourcey-public-api.md) · [All operations](https://skmtc.dev/sourcey/apis/sourcey-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sourcey/apis/sourcey-public-api/revisions/437166b51fa5?raw)