Tcf purpose management

Get TCF purposes from GVL

GET
/organizations/{organizationId}/projects/{projectId}/tcf-purposes

Retrieve IAB TCF purposes, special purposes, features, or special features from the Global Vendor List.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

organizationId*string
Formatuuid
projectId*string
Formatuuid

Query Parameters

type?string
Default"purpose"

Value in

  • "purpose"
  • "specialPurpose"
  • "feature"
  • "specialFeature"
  • "stack"
  • "dataCategory"
ids?string
search?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/tcf-purposes"
{  "gvlSpecificationVersion": 0,  "vendorListVersion": 0,  "tcfPolicyVersion": 0,  "type": "string",  "purposes": [    {      "id": 0,      "name": "string",      "description": "string",      "descriptionLegal": "string",      "illustrations": [        "string"      ],      "purposes": [        0      ],      "specialPurposes": [        0      ],      "features": [        0      ],      "specialFeatures": [        0      ]    }  ],  "count": 0}