---
title: "Published registry with license summaries and categories"
method: GET
path: "/v1/catalog"
tags: ["Rights desk"]
---

# Published registry with license summaries and categories

`GET /v1/catalog`

## Request

- Base URL: `https://www.rightshold.com`
- URL: `https://www.rightshold.com/v1/catalog`
- Auth: one of:
  - none
  - HTTP bearer

## Query parameters

- `q` string
- `category` string
- `license` string

## Headers

- `X-Request-Id` string

## Response `200`

OK

- object: Inferred from 7 recorded responses; required fields appeared in every one; additional properties may appear.
  - `resources` object[], required
    - `id` string, required
    - `title` string, required
    - `category` string, required
    - `category_label` string, required
    - `summary` string, required
    - `tags` string[], required
    - `version` string, required
    - `content_sha256` string, nullable, required
    - `source_url` string, required
    - `terms_url` unknown, required
    - `license` object, required
      - `id` string, required
      - `name` string, required
      - `short` string, required
      - `url` string, required
      - `page` string, required
    - `rights` object, required
      - `profile_id` string, required
      - `reviewed` boolean, required
      - `rights_authority` string, required
      - `authority_note` string, required
      - `permissions` string[], required
      - `prohibitions` string[], required
      - `needs_review` string[], required
      - `duties` string[], required
    - `terms` object, required
      - `id` string, required
      - `version` string, required
      - `uri` string, required
      - `content_hash` string, required
    - `publisher` object, required
      - `handle` string, nullable, required
      - `display_name` string, required
    - `status` string, required
    - `ledger_seq` integer, required
    - `published_at` string, required
    - `links` object, required
      - `page` string, required
      - `license` string, required
  - `categories` object[], required
    - `id` string, required
    - `label` string, required
    - `blurb` string, required
    - `count` integer, required
  - `licenses` string, required

## Other responses

- `400`: Problem details: a stable error code, type URI, title, status and an explanation
- `401`: Problem details: a stable error code, type URI, title, status and an explanation
- `404`: Problem details: a stable error code, type URI, title, status and an explanation
- `405`: Problem details: a stable error code, type URI, title, status and an explanation
- `422`: Problem details: a stable error code, type URI, title, status and an explanation
- `429`: Request budget exhausted; retry after Retry-After seconds
- `500`: Problem details: a stable error code, type URI, title, status and an explanation

---

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