# Get Entities

This API endpoint enables fetching a collection of entities within a given FloQast tenant. Optional query parameters can either narrow the API response or provide pagination functionality.


Endpoint: GET /api/v1/entities
Version: 1.0.0
Security: x-api-key

## Query parameters:

  - `filter[name]` (string)
    Specifies the name of the entity. Cannot be used with page[number].
    Example: "Entity Name"

  - `page[size]` (integer)
    The number of items to return. If not specified, the API will return a default of 30,000 items, which is the maximum value.
    Example: 12000

  - `page[number]` (integer)
    Indicates the page number of the results to retrieve. This parameter is used to paginate through lists of items. Cannot be used with filter[name].
    Example: 5

  - `allowRedirect` (boolean)
    If set to true, the API will return a 303 redirect response if the response payload is too large. The header  and  will also include the URL to the actual resource.
    Example: true

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (string)
    Example: "5e94d5b63f557b001420bbe3"

  - `data.name` (string)
    Example: "TB1 5e94d5b63f557b001420bbe3"

  - `data.details` (string)
    Example: "Client ID: 123ABC"

## Response 303 fields (application/json):

  - `data` (object)

  - `data.url` (string)
    The URL to the new location of the resource.

## Response 400 fields (application/json):

  - `message` (object)
    Reason(s) for the errors related to incorrect query keys or values that are out of bound

  - `message.errors` (array)

  - `message.errors.field` (string)
    The field that caused the error
    Example: "filter[name]"

  - `message.errors.message` (string)
    The error message
    Example: "filter[name] must be a string containing only letters, numbers, and spaces, and limited to one entry."

  - `name` (string)
    BadRequest
    Example: "BadRequest"

  - `status` (integer)
    The HTTP status code.
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Reason for the error such as incorrect service access, malformed, expired or deactivated token.
    Example: "Invalid token"

  - `name` (string)
    Unauthorized
    Example: "Unauthorized"

  - `status` (integer)
    The HTTP status code.
    Example: 401

## Response 413 fields (application/json):

  - `message` (string)
    Reason for the error related to the payload size
    Example: "Response size is greater than 1MB"

  - `name` (string)
    PayloadTooLarge
    Example: "PayloadTooLarge"

  - `status` (integer)
    The HTTP status code.
    Example: 413