Log in to see full request history

Retrieve multiple requests

The following example returns a paginated collection of all available forgetRequests resources available to the user identified by the Authorization header. This supports various query string parameters which are described below.

Identifiers

There is the notion of an identifier. These values identify an end-user on various social platforms including Bazaarvoice. Only one identifier can be used in the querystring filter. For instance, ?emailAddress=test@test.com&instagramUsername=catlover is not available. The following are the available identifiers:

emailAddress
authorId
phoneNumber
instagramUsername

Query String Filters

NameDescription
idRequest ID for a submitted ROA request.
identifierRefer to the table mentioned above
clientNameAvailable client instance names
completedAfterDate in ISO format yyyy-mm-ddThh:mm:ss:SSSZ 2023-05-04T18:18:45.009Z
submittedAfterDate in ISO format yyyy-mm-ddThh:mm:ss:SSSZ 2023-05-04T18:18:45.009Z
statusAvailable values: PENDING , COMPLETED.
limitThe maximum number of requests to return. If no limit is specified the default is 100

❗️

The status ABORTED is deprecated.

Query Params
string
required

API Passkey for the client instance. Please check our API key requestpage for more details.

string
string
string
string
string
string

Available values are PENDING and COMPLETED

string
date-time

Date in ISO format yyyy-mm-ddThh:mm:ss:SSSZ 2023-05-04T18:18:45.009Z

date-time

Date in ISO format yyyy-mm-ddThh:mm:ss:SSSZ 2023-05-04T18:18:45.009Z

int32
≤ 1000
Defaults to 100

The maximum number of requests to return.

string

The token to get the next page of requests.

Responses

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json