younifyd
Menu

Get Related Data Entries

Get Personal Data Related Data Entries

GET/v2/personal-data/related-data-entries

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get Related Data Entries action (under Personal Data).
  3. Fill in the fields below, then reference the result from later steps as {{getRelatedDataEntries.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 {{getRelatedDataEntries.response.data.<field>}}.

dataarray<object>
resource_typestring

The type of a related data entry.

resource_idstring (uuid)

The ID of a related data entry.

typestring

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

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": [
    {
      "resource_type": "user-authentication-info",
      "resource_id": "00000000-0000-1000-8000-111111111112",
      "type": "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.