Retrieve a list of Requests

GET 
/v2/data_control/requests

Query Requests by some given filters

Request

Query Parameters

per_page integer

How many records to show per page in the range [1, 100]. Defaults to 25

page integer

The current page to fetch results from. Defaults to 1

include_paging_counts boolean

Whether to include total_pages and total_count in the metadata. Defaults to false

sort_by string

Key to sort on, must be one of: inserted_at. Defaults to inserted_at

sort_direction string

Direction to sort in, must be one of: ASC, DESC. Defaults to DESC

team_id integer

Internal Use Only

request_type string

Standardized type of the Request

dry_run boolean

Whether or not the Request was a dry run

user_guid string

User guid

Responses

200

Success

application/json

Schema

Schema

user_guid string

ID of the user who created the Request

team_id integer

ID of the Request's target team

request_type string

Standardized type of the Request

metadata object

Data that varies across Request types

id integer

ID of the Request

events object[]
Instances in which a Request has been executed
Array [
]
dry_run boolean

Whether or not to change data

Example (from schema)

{
  "user_guid": "46dd5510-3794-4daa-a22f-bbf13f510a96",
  "team_id": 1234,
  "request_type": "right_to_be_forgotten",
  "metadata": {
    "people_ids": [
      1,
      2,
      3
    ]
  },
  "id": 42,
  "events": [],
  "dry_run": true
}

Loading...