---
title: "What the species registers we hold say about one species, each status cited"
method: GET
path: "/designations"
---

# What the species registers we hold say about one species, each status cited

`GET /designations`

## Request

- Base URL: `https://passage-data.com/api/v1`
- URL: `https://passage-data.com/api/v1/designations`
- Auth: one of:
  - none
  - HTTP bearer
  - API key in header `x-api-key`

US Endangered Species Act lists, Canada's Species at Risk Act and COSEWIC, provincial acts, the IUCN Red List, CITES, CMS, the EU Habitats and Birds Directives' annexes and UK schedules. Each row: the status as printed, an outcome (listed, listed_qualified = only under a population or subspecies to confirm, watch_listed, assessed_not_listed, scope_undetermined), and a cite block (instrument, edition, the line the register prints, source URL and sha256). Registers searched that do not name the species are in `silent`, with what each one's silence means.

## Query parameters

- `species` string, required
- `place` string

## Response `200`

Rows, or a `refused` block (designations.none_held with registers_searched, species.unreadable, species.ambiguous with candidates)

- Designations
  - `query` object
  - `name` object
  - `searched` object
  - `total` integer
  - `designations` Designation[]
    - `register` string
    - `name` string
    - `status` string
    - `outcome` string
    - `outcome_says` string
    - `matched_at` string
    - `place` string[]
    - `legal_instrument` boolean
    - `kind` string
    - `population` string, nullable
    - `asks` string, nullable
    - `note` string, nullable
    - `cite` Cite
      - `instrument` string
      - `title` string
      - `issuer` string, nullable
      - `edition` string, nullable
      - `section` string, nullable
      - `page` union
        - integer
        - string
      - `quote` string, nullable
      - `source_url` string, nullable
      - `source_sha256` string, nullable
      - `source_status` object: What the daily edition watch last saw at the source: status unchanged, changed (with changed_on and says: the rows are as read from the edition named, not yet re-read) or not verified; checked is the day.
        - `checked` string
        - `status` 'unchanged' | 'changed' | 'not verified'
        - `changed_on` string
        - `says` string
      - `note` string: What the register prints beside the value (e.g. a later or earlier value and its date).
      - `table` string
      - `column` string: The register column the value sits in (e.g. mcl, mclg).
  - `silent` object[]
  - `refused` object

## Other responses

- `400`: species.missing, place.malformed

---

[API](https://skmtc.dev/passage-data/apis/passage-data-cited-environmental-limits.md) · [All operations](https://skmtc.dev/passage-data/apis/passage-data-cited-environmental-limits/llms.txt) · [OpenAPI document](https://skmtc.dev/passage-data/apis/passage-data-cited-environmental-limits/revisions/ba066708bf53?raw)