---
title: "List entities"
method: GET
path: "/api/v1/entities"
tags: ["Entities"]
---

# List entities

`GET /api/v1/entities`

## Response `200`

Successful

- SerializedEntitiesList
  - `data` SerializedEntity[]
    - `data` object
      - `id` string
      - `type` string
      - `attributes` object
        - `name` string — Name of the entity
        - `passDeeplinks` object — When clicked on a device, will direct the user to the pass in their wallet. Replace {PASSENTRY_PASS_UUID} with the pass UUID.
          - `apple` string — Apple Wallet Pass Deeplink
          - `google` string — Google Wallet Pass Deeplink
  - `meta` IndexMeta
    - `totalCount` integer — Total count of records returned
    - `resultsPerPage` integer — Number of records returned per page. Set using the perPage query parameter.
    - `currentPage` integer — Index of current page
    - `totalPages` integer — Total pages returned
  - `links` IndexLinks
    - `first` string, nullable — Path to first page, null if currentPage is first page
    - `prev` string, nullable — Path to prev page, null if currentPage is first page
    - `next` string, nullable — Path to next page, null if currentPage is last page
    - `last` string, nullable — Path to last page, null if currentPage is last page

## Other responses

- `401` — Error: Unauthorized

---

[API](https://skmtc.net/passentry/apis/passentry-api.md) · [All operations](https://skmtc.net/passentry/apis/passentry-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/passentry/passentry-api/versions/2c7dc0306b04/schema)
