younifyd
Menu

Get Erasure Requests

Get all Personal Data Erasure Request

GET/v2/personal-data/erasure-requests

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get Erasure Requests action (under Personal Data).
  3. Fill in the fields below, then reference the result from later steps as {{getErasureRequests.response.data}}.

Request

Query parameters

page[offset]integer (int64)

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](/docs/api/settings/settings-introduction#page-length) store setting is used.

page[limit]integer (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](/docs/api/settings/settings-introduction#page-length) store setting is used.

filterstring (string)

Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.

Response

Returns 200 with an object. Read it in later steps with {{getErasureRequests.response.data.<field>}}.

dataarray<object>
idstring (uuid)

The unique identifier for the log entry.

resource_typestring

The type of the data entry to be erased.

resource_idstring (uuid)

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

typestring

The type of the object. Always equal to `erasure_request`.

initiatorobject5 fields

Specifies who initiated the erasure request.

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.

linksobject1 fields
metaobject
resultsobjectrequired1 fields
pageobjectrequired4 fields
linksobject
currentstring | nullrequired

Always the current page.

firststring | nullrequired

Always the first page.

laststring | nullrequired

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.

json
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "resource_type": "account",
      "resource_id": "98140362-6caf-4829-b93d-953ac6adbe6e",
      "type": "string",
      "initiator": {
        "access-token-email": "accounts@elasticpath.com",
        "access-token-id": 1222341536243516000,
        "access-token-name": "elastic path test team",
        "access-token-store-id": "15ea9633-278c-4807-80f7-2009fed63c7e",
        "access-token-type": "client-credentials-token"
      },
      "status": "string",
      "status_description": "string",
      "created_at": "string",
      "updated_at": "string",
      "links": {
        "self": "string"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 1
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    }
  },
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.