---
title: "Get record and its fields by alias"
method: GET
path: "/token/records"
tags: ["Vault Records and Aliases"]
---

# Get record and its fields by alias

`GET /token/records`

Retrieve a record and all fields associated with the record by the alias of one of its fields.

## Query parameters

- `alias` string, required
- `includeVolatileInfo` boolean
- `includeDetokenizations` boolean

## Response `200`

Record and its fields.

- object
  - `id` string, uuid — Payrails unique identifier of the record.
  - `type` string — Type of this record, e.g. `card` or `networkToken`.
  - `fingerprint` string — The fingerprint of the record. Depending on type can be used to match with other records.
  - `fields` object[] — Fields belong to this record.
    - `alias` string — Merchant-facing unique alias for the field. Used as an identifier.
    - `recordId` string — Identifier of the record to which the alias belongs.
    - `recordType` string — Record type to which this field belongs, e.g. `card` and `networkToken`.
    - `fieldType` string — Field type of the alias, e.g. `cardNumber`, `expiryMonth`, `expiryYear`, `securityCode`, `holderName`, `networkToken`, `cryptogram`.
    - `displayableValue` string, nullable — Displayable value for the field.
    - `allowedDetokenizationCount` integer, nullable — It will be restricted if used on a proxy and reaches the limit mentioned in this field.
    - `allowedSdkRevealCount` integer, nullable — It will be restricted if used on a SDK reveal and reaches the limit mentioned in this field.
    - `hasValue` boolean, nullable — Indicates whether the volatile field has a value associated with it. If false or not present, the field has been deleted or was never set.
    - `maximumExpirationDate` string, date-time, nullable — The maximum expiration date for the volatile field value. After this date, the field value will be deleted. Please note that depending on usage of volatile field, value can be deleted even earlier, for example if allowed detokenization or reveal counts are exceeded, or when you explicitly call delete operation on the field.
    - `detokenizations` object[], nullable — List of detokenization attempts performed on this field. This field is returned only when requested via `includeDetokenizations` query parameter.
      - `lastAttemptedAt` string, date-time — Timestamp when the detokenization was attempted.
      - `count` integer — Number of times this type of detokenization was successfully performed.
      - `type` 'detokenization' | 'sdkReveal' — Type of detokenization attempt. `detokenization` indicates a standard detokenization, while `sdkReveal` indicates a detokenization performed via SDK reveal.

## Other responses

- `401` — Unauthorized.
- `403` — Insufficient Scope.
- `404` — Not Found.
- `422` — Unprocessable Entity.

---

[API](https://skmtc.net/payrails/apis/payrails-api-reference.md) · [All operations](https://skmtc.net/payrails/apis/payrails-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payrails/payrails-api-reference/revisions/9dd2f0158582/schema)