---
title: "Get all active consent wards"
method: GET
path: "/consent/wards"
tags: ["Consent"]
---

# Get all active consent wards

`GET /consent/wards`

## Request

- Base URL: `https://api.kontainer.com/jsonapi/v2`
- URL: `https://api.kontainer.com/jsonapi/v2/consent/wards`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kontainer/apis/kontainer-api-documentation/docs/consent/wards/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint returns all active wards. If the persons associated with the wards need to be included, 'consent_parties' can be added to the relationship parameter.

## Query parameters

- `relationships` string
- `includes` string
- `filter` object
- `page` number
- `pageSize` number

## Response `200`

success

- ConsentResponse: Paginated list of consent-ward resources
  - `data` ConsentWardData[]
    - `type` string
    - `id` string
    - `attributes` object
      - `name` string
      - `birthday` string, date, nullable
    - `relationships` object: Present only when consent_parties is requested via the relationships parameter.
      - `consent_parties` object
        - `data` object[]
          - `type` string
          - `id` string
  - `included` object[]: Included consent_party resources, present only when requested via the includes parameter.
  - `links` Links
    - `first` string
    - `last` string
    - `prev` string, nullable
    - `next` string, nullable
  - `meta` Meta
    - `current_page` integer
    - `from` integer
    - `last_page` integer
    - `links` Link[]
      - `url` string, nullable
      - `label` string
      - `active` boolean
    - `path` string
    - `per_page` integer
    - `to` integer
    - `total` integer
    - `filter` union: The `filter` query parameter echoed back as sent; an empty array when none was sent
      - object
      - unknown[]
        - unknown
    - `sort` string

## Other responses

- `401`: Unauthorized

---

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