purposes

Retrieve a list of purposes

Changed on

Returns a list of all purposes

get/metadata/purposes

Request

  • Base URL
    https://api.didomi.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.didomi.io/metadata/purposes
  • Auth
    HTTP bearer

Query parameters

$translationsboolean

If true, will return translatable fields as objects with translations

organization_idstring required

The ID of the organization that the user belongs to

$limitnumber

Number of max results to return

$skipnumber

Number of results to skip

updated_atnumber
created_atnumber

Object representing sorting options. Accepts properties to sort as keys and -1 or 1 for sort direction

Response

A list of Purpose objects

totalnumber

The total amount of purposes

limitnumber

The limit of purposes on this query

skipnumber

Number of purposes skipped

Changes

  • c82339816c36Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status