# Get Active Entity Definitions

**GET /entity-definitions**

The purpose of the "Get Entity Definition List" call is to return a list of ALL Close-
Entities that are in Close. The data is similar to what might be seen in the "Details" and
"Subtasks" section on the Entity Definition. Details page in Close, and nothing relating to any specific period is returned.



## 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 identifier of the period. Only entities which are part of the specified period will be returned
- **parentId** (string)
  The identifier of the parent entity to return.  Included in the result as the single 'root' entity along with all children.


## 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)