---
title: "Retrieve all entities for a given time range"
method: GET
path: "/customers/v1/entities"
tags: ["Entities"]
---

# Retrieve all entities for a given time range

`GET /customers/v1/entities`

Retrieves a list of entities created for a specific application within the provided time range.
The entities are paginated, and the query parameters allow filtering by start and end dates.

## Query parameters

- `page_number` integer
- `page_size` integer
- `start_date` string, date, required
- `end_date` string, date, required

## Response `200`

- EntityListResponse
  - `data` EntityResponse[], required
    - `id` string, uuid, required — The `entity_id`
    - `customer_id` string, uuid, required — Identifies which Customer owns the connection
    - `bank_identifier` string, required — Identifies the bank which has been connected
    - `permissions` Permissions, required — Indicates which permissions have been granted by the user, this corresponds with the Data API calls you can make using the entity.
      - `identity` boolean, required — Indicates access to read identity data
      - `accounts` boolean, required — Indicates access to read accounts data
      - `balance` boolean, required — Indicates access to read balance data
      - `transactions` boolean, required — Indicates access to read transactions data
      - `identities` boolean, required — Indicates access to read identities data
      - `scheduled_payments` boolean, required — Indicates access to read scheduled payments data
      - `standing_orders` boolean, required — Indicates access to read standing orders data
      - `direct_debits` boolean, required — Indicates access to read direct debits data
      - `beneficiaries` boolean, required — Indicates access to read beneficiaries data
    - `bank_type` 'RETAIL' | 'SME', required — Specifies whether the Entity is a Retail or Corporate owned account.
    - `created_at` string, date-time, required — When the entity was created
    - `consents` EntityConsent[], required
      - `id` string, uuid, required — Lean internal id for the consent.
      - `bank_consent_id` string — Id provided by the bank for the consent.
      - `bank_identifier` string — Identifies the bank which has been connected
      - `consent_type` 'ACCOUNT_ACCESS' | 'MULTI_PAYMENTS' — Type of the consent.
      - `consent_status` 'ACTIVE' | 'REVOKED' | 'REJECTED' — Status of the consent.
      - `standard_consent_status` 'AUTHORISED' | 'REVOKED' | 'REJECTED' | 'EXPIRED' | 'CONSUMED' | 'SUSPENDED' — Standard Status of the consent.
      - `permissions` Permissions — Indicates which permissions have been granted by the user, this corresponds with the Data API calls you can make using the entity.
        - `identity` boolean, required — Indicates access to read identity data
        - `accounts` boolean, required — Indicates access to read accounts data
        - `balance` boolean, required — Indicates access to read balance data
        - `transactions` boolean, required — Indicates access to read transactions data
        - `identities` boolean, required — Indicates access to read identities data
        - `scheduled_payments` boolean, required — Indicates access to read scheduled payments data
        - `standing_orders` boolean, required — Indicates access to read standing orders data
        - `direct_debits` boolean, required — Indicates access to read direct debits data
        - `beneficiaries` boolean, required — Indicates access to read beneficiaries data
      - `creation_date_time` string, date-time — When the consent was created.
      - `status_update_date_time` string, date-time, nullable — Last update for the consent.
      - `expiration_date_time` string, date-time, nullable — When the consent is or will no longer be valid.
      - `transaction_from_date_time` string, date-time, nullable — For consents that include a `permission` for `transactions`, the first date of the transactions you can request for.
      - `transaction_to_date_time` string, date-time, nullable — For consents that include a `permission` for `transactions`, the last date of the transactions you can request for.
      - `accounts` DataAccountIdentifier[] — Accounts the end user has consented to share.
        - `scheme_name` string, required — Indicates the type of identification being provided. | Value | Description | |-|-| | IBAN | The `identification` field is returning the IBAN for the account. | | MASKED_PAN | The `identification` field is returning a masked Primary Account Number (PAN) for a card attached to the account. |
        - `identification` string, required — The account identification value
        - `name` string, nullable — The name associated with the account
        - `secondary_identification` string, nullable — Secondary identification for the account
    - `status` 'ACTIVE' | 'DELETED' | 'DISABLED' | 'REMOVED', required
    - `updated_at` string, date-time, required
  - `page` PageMetadata, required — Metadata about the current page of results
    - `number` integer, required — The current page being returned by the API
    - `size` integer, required — The page size requested
    - `total_elements` integer, required — The total number of elements in all pages
    - `total_pages` integer, required — The total number of pages retrievable
    - `sort` string[] — Sort parameters applied to the results

---

[API](https://skmtc.net/leantech/apis/auth.md) · [All operations](https://skmtc.net/leantech/apis/auth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/leantech/auth/revisions/c2e46d54d886/schema)