Skip to main content

Get all Personal Data Erasure Request

GET 
https://useast.api.elasticpath.com/v2/personal-data/erasure-requests

Gets a list of erasure requests for a specific resource id and resource type.

You can use pagination with this resource. For more information, see pagination.

Filtering​

The following operator and attributes are required for filtering erasure requests.

OperatorDescription
eqChecks whether the values of two operands are equal. If the values are equal, the condition is true.
AttributeTypeOperatorExample
resource_typestringeqeq(resource_type,customer)
resource_idstringeqeq(resource_id,0f850c15-d643-480a-a2b4-9e3c26067178\)

Request​

Query Parameters

    page[offset] int64

    Possible values: <= 10000

    The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

    page[limit] int64

    The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

    filter string

    Filter attributes. For more information, see the Filtering section.

Responses​

OK

Schema
    data ErasureRequestResponse[]
  • Array [
    • iduuid

    The unique identifier for the log entry.

    resource_typestring

    The type of the data entry to be erased.

    Example: account
    resource_iduuid

    The ID of the data entry to be erased (note that also all data entries in the personal data set will be erased).

    Example: 98140362-6caf-4829-b93d-953ac6adbe6e
    typestring

    The type of the object. Always equal to erasure_request.

    initiator object

    Specifies who initiated the erasure request.

    access-token-emailstring
    Example: accounts@elasticpath.com
    access-token-idstring
    Example: 1222341536243516000
    access-token-namestring
    Example: elastic path test team
    access-token-store-iduuid
    Example: 15ea9633-278c-4807-80f7-2009fed63c7e
    access-token-typestring
    Example: client-credentials-token
    statusstring

    Specifies the status of the erasure request.

    status_descriptionstring

    Elaborates on the erasure request status.

    created_atstring

    Specifies the status of the erasure request.

    updated_atstring

    Elaborates on the erasure request status.

    links object
    selfstring

    The self link.

  • ]
    • meta object
    results objectrequired
    totalinteger

    Total number of results for the entire collection.

    Example: 1
    page objectrequired
    limitinteger

    The maximum number of records for all pages.

    Example: 100
    offsetinteger

    The current offset by number of pages.

    Example: 0
    currentinteger

    The current number of pages.

    Example: 1
    totalinteger

    The total number of records for the entire collection.

    Example: 1
    links object
    currenturirequired

    Always the current page.

    firsturirequired

    Always the first page.

    lasturirequired

    Always null if there is only one page.

    nextstring | nullrequired

    Always null if there is only one page.

    prevstring | nullrequired

    Always null if the user is on the first page.

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/personal-data/erasure-requests");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://useast.api.elasticpath.com
Auth
Parameters
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!