---
title: "Retrieve a list of purposes"
method: GET
path: "/metadata/purposes"
tags: ["purposes"]
---

# Retrieve a list of purposes

`GET /metadata/purposes`

Returns a list of all purposes

## Query parameters

- `$translations` boolean
- `organization_id` string, required
- `$limit` number
- `$skip` number
- `$sort` object
  - `updated_at` number
  - `created_at` number

## Response `200`

A list of Purpose objects

- object — A paginated list of Purpose objects
  - `total` number — The total amount of purposes
  - `limit` number — The limit of purposes on this query
  - `skip` number — Number of purposes skipped
  - `data` Purposes[]
    - `id` string, required — Purpose ID
    - `description` object — Name of the purpose
    - `details` object — Details of the purpose
    - `enabled_status_description` object — Description of the purpose when the sdk status for the user for this purpose is enabled
    - `disabled_status_description` object — Description of the purpose when the sdk status for the user for this purpose is disabled
    - `reference` object — The reference number uniquely identifies the purpose in an official classification like the one from the CNIL
    - `organization_id` string — Id of organization which purpose belongs to. If id is null, purpose is global
    - `created_at` string, date-time — Creation date of the purpose
    - `updated_at` string, date-time — Last update date of the purpose
    - `namespaces` object — IDs of this purpose in other namespaces / vendor lists and used in Didomi SDKs and consents
      - `iab` string — ID of the purpose in the IAB TCF version 1
      - `iab2` string — ID of the purpose in the IAB TCF version 2 (only allowed if "iab2_special_feature" is not present)
      - `iab2_special_feature` string — ID of the special feature in the IAB TCF version 2 (only allowed if "iab2" is not present)
      - `didomi` string — ID of the purpose in the Didomi SDK
      - `custom` string — Custom ID for the purpose
    - `regulations_id` string[] — An array of regulation IDs the purpose supports
    - `type` string — The purpose type discriminator.
    - `metadata` object — Metadata for additional information
    - `opted_out_by_gpc` boolean — Whether the purpose is opted out when a Global Privacy Control (GPC) signal applies
    - `necessary_to_generate_revenue` boolean — Whether the purpose is necessary to generate revenue (Consent or Pay)

---

[API](https://skmtc.net/didomi/apis/didomi-api.md) · [All operations](https://skmtc.net/didomi/apis/didomi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/didomi/didomi-api/revisions/70997bf7efc9/schema)