# Fetch all entities

**GET /entities**

Retrieve a paginated list of entities for a specified period, which includes their associated dependent entities.

To acquire this data, the crucial parameter is `periodId`, ensuring the retrieval of all pertinent entities tied to the
designated time frame while allowing for efficient pagination control.



## Servers
- https://usaapi02.cadencyservices.trintech.com/test/api: https://usaapi02.cadencyservices.trintech.com/test/api ()


## Authentication methods
- Oauth2


## Parameters


### Query parameters
- **page** (integer(int32))
  The `page` define the current page number. It should be positive integer number and should start with minimum value 1.
- **size** (integer(int32))
  The `size` define number of records on each page. It should be positive integer number between 1 to 10000.
- **sort** (array[string])
  The `sort` parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending.
- **name** (string)
  The `name` parameter is an optional filter that allows you to narrow down the results based on specific name content.
- **periodId** (string)
  The id of the period for which entity instances are required


## Responses
### 200
The requested page of entities.

#### Body: application/json (object)
- **result** (array[object])

- **metadata** (object)
  Paging metadata dto.


[Powered by Bump.sh](https://bump.sh)