---
title: "The search endpoint (beta)"
method: POST
path: "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search"
tags: ["Workspaces - Settings"]
---

# The search endpoint (beta)

`POST /api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search`
- Auth: none declared

## Path parameters

- `workspaceId` string, required

## Query parameters

- `origin` 'ALL' | 'PARENTS' | 'NATIVE': Defines scope of origin of objects. All by default.

## Headers

- `X-GDC-VALIDATE-RELATIONS` boolean

## Request body

- EntitySearchBody: Request body for entity search operations
  - `filter` string, nullable: Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').
  - `include` string[], nullable: List of related entities to include in the response
  - `metaInclude` string[], nullable: Set of metadata fields to include in the response
  - `page` EntitySearchPage: Pagination information for entity search
    - `index` integer, required: Zero-based page index
    - `size` integer, required: Number of items per page
  - `sort` EntitySearchSort[], nullable: Sorting criteria (can specify multiple sort orders)
    - `direction` 'ASC' | 'DESC': Sort direction
    - `property` string, required: Property name to sort by

## Response `200`

Request successfully processed

- JsonApiCustomApplicationSettingOutList: A JSON:API document with a list of resources
  - `data` JsonApiCustomApplicationSettingOutWithLinks[], required
    - `attributes` object, required
      - `applicationName` string, required
      - `content` object, required: Free-form JSON content. Maximum supported length is 250000 characters.
    - `id` string, required: API identifier of an object
    - `meta` object
      - `origin` object
        - `originId` string, required: defines id of the workspace where the entity comes from
        - `originType` 'NATIVE' | 'PARENT', required: defines type of the origin of the entity
    - `type` 'customApplicationSetting', required: Object type
    - `links` ObjectLinks
      - `self` string, uri, required: A string containing the link's URL.
  - `links` ListLinks
    - `self` string, uri, required: A string containing the link's URL.
    - `next` string, uri: A string containing the link's URL for the next page of data.
  - `meta` object
    - `page` PageMetadata
      - `number` integer: The number of the current page
      - `size` integer: The size of the current page
      - `totalElements` integer: The total number of elements
      - `totalPages` integer: The total number of pages

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)