OSosano
dsar

List Subject Rights Requests

Query for Subject Rights Requests. Results are sorted in descending order by creation time. The number of results returned may be controlled via the limit param, but may not exceed 500. The "next" object in the response may be used to retrieve subsequent pages of the same resource. Test requests are excluded unless the testRequests param is set to include or only.

get/v1/subject-rights/requests

Request

Query parameters

limitinteger

The number of items to return.

nextstring

The pagination token from the previous request.

afterstring

Specify UTC date and time in ISO-8601 format (e.g. 2021-01-01T00:00:00Z) to filter items created after this date.

source'ADMIN' | 'AGENT_WEB' | 'API' | 'CMP' | 'CSV' | 'EMAIL_INTAKE' | 'WEB'

Source filter for the request. Must be one of ADMIN, AGENT_WEB, API, CMP, CSV, EMAIL_INTAKE, or WEB.

status'PENDING_EMAIL_VERIFICATION' | 'PENDING_IDENTITY_VERIFICATION' | 'IN_PROGRESS' | 'IN_REVIEW' | 'PENDING_APPEAL' | 'COMPLETED' | 'REJECTED' | 'REJECTED_AUTO'

Status filter for the request. Must be one of PENDING_EMAIL_VERIFICATION, PENDING_IDENTITY_VERIFICATION, IN_PROGRESS, IN_REVIEW, PENDING_APPEAL, COMPLETED, REJECTED, or REJECTED_AUTO.

requestType'CORRECT' | 'CUSTOM_1' | 'CUSTOM_2' | 'CUSTOM_3' | 'CUSTOM_4' | 'CUSTOM_5' | 'CUSTOM_6' | 'DELETE' | 'DO_NOT_SELL' | 'LIMIT_USE' | 'LIST_OR_CATEGORIES_OF_THIRD_PARTIES' | 'OPT_OUT' | 'OPT_OUT_OF_PROFILING' | 'OPT_OUT_OF_USING_SENSITIVE_DATA' | 'OTHER' | 'PORTABILITY' | 'RESTRICT_PROCESSING' | 'SUMMARIZE'

Request type filter for the request. Must be one of CORRECT, CUSTOM_1, CUSTOM_2, CUSTOM_3, CUSTOM_4, CUSTOM_5, CUSTOM_6, DELETE, DO_NOT_SELL, LIMIT_USE, LIST_OR_CATEGORIES_OF_THIRD_PARTIES, OPT_OUT, OPT_OUT_OF_PROFILING, OPT_OUT_OF_USING_SENSITIVE_DATA, OTHER, PORTABILITY, RESTRICT_PROCESSING, or SUMMARIZE

formIdinteger

Form identifier through which the Subject Rights Request was made.

testRequests'exclude' | 'include' | 'only'

Controls whether test Subject Rights Requests (or action items belonging to test requests) appear in the results. exclude (the default) returns only non-test requests, include returns both non-test and test requests, and only returns test requests.

Response

Success

nextstring

A token which may be appended to subsequent requests to retrieve the next page of results, i.e. ?next=...

Changes

No recorded changes to this operation across all 1 revision of this API.