# Retrieve Filtered Entities

Get record(s) using filters

Endpoint: GET /rest/2.0/ENTITY
Version: 1.0
Security: JWT

## Query parameters:

  - `queryAnsiSql` (string, required)
    SQL Where part

## Header parameters:

  - `sessionId` (string, required)

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.AllowAttributeTable` (string)
    AllowAttributeTable

  - `retrieveResponse.ApiEnabled` (string)
    ApiEnabled

  - `retrieveResponse.CascadeDeleteFlag` (string)
    Enable Cascade Delete: If selected, deleting a record that has a child record will delete the child record as well.

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.CustomLayout` (string)
    CustomLayout

  - `retrieveResponse.EntityName` (string)
    Entity Name: Specify the name that will be associated with the new entity in the system and in the API. It cannot include spaces and must have the following prefixes:- Custom Standard entity names must begin with C_- Custom View Based entity names must begin with CV_- Custom Configurable API entity names must begin with CA_

  - `retrieveResponse.Id` (string)
    Entity ID

  - `retrieveResponse.LookupEnabledFlag` (string)
    Enable Lookup: Select this option to use the new entity as a Lookup Field. Lookup Fields allow you to quickly look up information while inputting new records instead of switching between tabs to find customer information that may reside elsewhere in the application.

  - `retrieveResponse.ParentEntityId` (integer)
    ParentEntityId

  - `retrieveResponse.RecycleBinFlag` (string)
    Enable Recycle Bin: If selected, deleted records will be retained in the Recycle Bin for the duration defined in Recycle Bin Retention Days. During this period you will be able to restore or undelete them. If deselected (default), records will be permanently deleted.

  - `retrieveResponse.RelatedListFlag` (string)
    Enable Related List: Select this option (default) to allow using the new entity as a field in a Related List.

  - `retrieveResponse.RetentionDays` (string)
    Recycle Bin Retention Days: If Enable Recycle Bin is selected, specify how long the platform will keep the deleted records in the system before they are purged or permanently deleted. Once they are purged, they can no longer be restored or undeleted.

  - `retrieveResponse.SystemFlag` (integer)
    System Entity

  - `retrieveResponse.TableName` (string)
    Table Name

  - `retrieveResponse.VisibleFlag` (string)
    VisibleFlag

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.HistoryFlag` (string)
    Enable History: Select this option to automatically store in system logs the details about the changes made to the new entity.

  - `retrieveResponse.Widget` (integer)
    Page: Select a widget to override the entity default interface.

  - `retrieveResponse.HistoryRetentionDays` (string)
    History Retention Days: Select the number of days you want to retain records in History. Records will be deleted after Retention Days.

  - `retrieveResponse.EntityLabel` (string)
    Entity Label: Specify the name that will designate the new entity in the user interface.

  - `retrieveResponse.BaseEntityId` (integer)
    Base Entity: Select the base Entity based on which the View Entity will be constructed.

  - `retrieveResponse.ViewEntity` (integer)
    View Based Entity: Select this box to create a virtual read-only entity that returns non-editable data.

  - `retrieveResponse.LongHelpDescription` (string)
    Long Help Content: A detailed description of the entity that will appear in the Long Help Content field of the Help System section in the entity profile.

  - `retrieveResponse.ExternalHelpTarget` (string)
    ExternalHelpTarget

  - `retrieveResponse.HelpLanguage` (string)
    HelpLanguage

  - `retrieveResponse.CreateDefaultFields` (string)
    CreateDefaultFields: Create default fileds (Id, Created, Updated, etc.)

  - `retrieveResponse.ParentNode` (string)
    ParentNode

  - `retrieveResponse.AfterNode` (string)
    Position in Tree Menu: After Node_Id. (-1) - as first-child of the parent node; NULL - as last-child of the parent node

  - `retrieveResponse.Node` (string)
    Node: Node_Id

  - `retrieveResponse.EnableAutoSearch` (string)
    Enable Auto Search: If this option is selected (default), the corresponding records will be automatically loaded when the entity is opened in the UI. Otherwise, you will need to manually load the records by using search or clicking Refresh.

  - `retrieveResponse.HideFromTreeMenu` (string)
    HideFromTreeMenu: If this option is selected, the entity will not appear in the UI as a separate node, regardless of being a parent or a child node.

  - `retrieveResponse.CascadePermitionsFlag` (string)
    Cascade Permissions to Entity Fields

  - `retrieveResponse.ShortHelpLabel` (string)
    ShortHelpLabel: A short description of the entity that will appear in the Short Help Content field of the Help System section in the entity profile.

  - `retrieveResponse.BaseEntity` (string)
    BaseEntity: Base Entity Name

  - `retrieveResponse.ViewFilterLogic` (string)
    ViewFilterLogic

  - `retrieveResponse.RevenueRecognitionEligible` (integer)
    Revenue Recognition Eligible: When checked, Revenue Recognition Eligible field enables use of the entity as a transaction source for GL Rules (default unchecked)

  - `retrieveResponse.InputForm` (string)
    InputForm: Input Form Id

  - `retrieveResponse.IsApplicationDeployable` (integer)
    Is Application Deployable: Application deployable entities can be bundled and then deployed into other organizations.

  - `retrieveResponse.LabelId` (string)
    LabelId

  - `retrieveResponse.AllowCache` (integer)
    Allow Cache

  - `retrieveResponse.QuickSearchFlag` (integer)
    Enable Quick Search: Enables Quick Search for entity.

  - `retrieveResponse.VirtualEntityFlag` (integer)
    VirtualEntityFlag

  - `retrieveResponse.CreateSearchForm` (string)
    Create Search Form: Selecting this box (default) creates a basic search form for your new entity.

  - `retrieveResponse.ListForm` (string)
    ListForm

  - `retrieveResponse.AllowEditsForRejectedRecords` (string)
    Allow Edits for Rejected Records

  - `retrieveResponse.ListSingleResultBehavior` (string)
    List Single Result Behavior: List Single Result Behavior

  - `retrieveResponse.GlobalSearchFlag` (integer)
    Include in Global Search: When enabled, this entity will be included in the global search index, allowing records related to entity to be found using the global search dialog. You can access this search from any page by pressing Ctrl-K or Cmd-K (for mac users).

  - `retrieveResponse.GlobalSearchStatus` (string)
    Global Search Status: INDEXING - platform is indexing objects.COMPLETED - search index is ready to use, objects are indexed.

  - `retrieveResponse.HighLoadFlag` (integer)
    High Load Flag

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error