v1

latestOpenAPI 3.0.22026-07-1319091298.3 KB
purposes

Retrieve a list of purposes

Returns a list of all purposes

get/metadata/purposes

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