---
title: "Gets data items for an entity (supports pagination and filters/queries)"
method: GET
path: "/v1/entities/{name}"
tags: ["entities"]
---

# Gets data items for an entity (supports pagination and filters/queries)

`GET /v1/entities/{name}`

Get the data items within a data set (supporting pagination).

Supports query string parameters (optional) to search within the data set. To support flexibility across entity definitions the main query parameters are two arrays: keys, values. These accept comma-separated lists.
If the number of keys and values in the request are not equal, the request will be rejected.

Supports single `eq` (equal) filtering, example:
    - id=eq.3
    - city=eq.London

Supports multiple `eq` (equal) filtering, example:
    - firstName=eq.Pedro&lastName=eq.Curado
    - city=eq.London&postcode=eq.SW13 9RQ

Supports single and multiple `neq` (not equal) filtering, example:
    - continent=neq.AS&continent=eq.EU 
    - continent=neq.AS&continent=neq.EU

Supports single `in` (in list) filtering, example:
    - name=in.(Portugal, United Kingdom)

Not supported yet:
    - currently only un-quoted values are supported this means that using values with commas will not return any values for instance: street=in.(Flat 2, 33 Joy St, London, Flat 9, 20 Sad St, London) 


Defaults to:

- returning both the schema and the data items (the data items can be omitted by setting `schemaOnly=true` in the query parameters)
- only returning ‘active’ data items (include inactive items by setting `includeInactive=true` in the query parameters).

## Path parameters

- `name` string, required

## Query parameters

- `keys` string[]
- `values` string[]
- `schemaOnly` boolean
- `includeInactive` boolean
- `offset` integer
- `limit` integer

## Response `200`

Success

- object
  - `status` string
  - `code` integer
  - `entityName` string
  - `entityLabel` string
  - `entitySchema` object
  - `offset` integer
  - `limit` integer
  - `data` unknown[]
    - unknown

## Other responses

- `400` — Bad request
- `401` — The user is not authorized to perform this request
- `404` — Not Found

---

[API](https://skmtc.dev/home-office/apis/reference-data-service-api.md) · [All operations](https://skmtc.dev/home-office/apis/reference-data-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/home-office/reference-data-service-api/revisions/97df0cb8be1b/schema)