Skip to main content

Get Personal Data Related Data Entries

GET 

https://useast.api.elasticpath.com/v2/personal-data/related-data-entries

Gets a list of related data entries filtered by specific resource id and resource type.

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

note
  • This request is only accessible to client_credentials token users with Seller Admin, Support and IT roles.
  • Non client_credentials token users cannot access this endpoint. See Permissions.
  • This request requires a filter for resource_type and resource_id.

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: >= 0 and <= 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

    Possible values: >= 0

    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 RelatedDataEntry[]
  • Array [
  • resource_typestring

    The type of a related data entry.

    Example: user-authentication-info
    resource_idstring<uuid>

    The ID of a related data entry.

    Example: 00000000-0000-1000-8000-111111111112
    typestring

    The type of the object. Always equal to related_data_entry.

    Constant value: related_data_entry
  • ]
  • 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
    currentstring,null<uri>nullablerequired

    Always the current page.

    firststring,null<uri>nullablerequired

    Always the first page.

    laststring,null<uri>nullablerequired

    Always null if there is only one page.

    nextstring | nullnullablerequired

    Always null if there is only one page.

    prevstring | nullnullablerequired

    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/related-data-entries");
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!