List entities

GET

///apis/entities/v2/workspaces/:workspace/entities/:entity_type

List all entities of a specific type in the given workspace.

Use workspace=”-” to list entities across all workspaces the principal has access to.

Query Parameters:

sort: Sort field
page, page_size: Pagination
filter: Advanced filters (JSON, text, or bracket notation)

Examples:

GET /apis/entities/v2/workspaces/default/entities/customization_config?sort=-created_at
GET /apis/entities/v2/workspaces/-/entities/customization_config  # Cross-workspace query

List all entities of a specific type in the given workspace. Use workspace="-" to list entities across all workspaces the principal has access to. Query Parameters: - sort: Sort field - page, page_size: Pagination - filter: Advanced filters (JSON, text, or bracket notation) Examples: ``` GET /apis/entities/v2/workspaces/default/entities/customization_config?sort=-created_at GET /apis/entities/v2/workspaces/-/entities/customization_config # Cross-workspace query ```

Path parameters

workspacestringRequired

entity_typestringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

Page number

page_sizeintegerOptional1-1000Defaults to 100

Items per page

sortstringOptionalDefaults to -created_at

Sort field

count_bystringOptional

Optional direct string data field whose matching values should be counted.

filterstringOptional

Query filter expression. Supports text and JSON syntaxes:

Text: name:“value” AND status>500 with operators : ~ > >= < <= IN NOT IN AND OR and negation prefix -
Object (JSON): {“name”:{“ $like":"value"}} with operators$ eq, $like,$ lt, $lte,$ gt, $gte,$ in, $nin,$ and, $or,$ not
Bracket notation: ?filter[name][$like]=value
Relationship traversal: ?filter[relationship][$exists]=true or ?filter[relationship][field]=value

Query filter expression. Supports text and JSON syntaxes: - Text: name:"value" AND status>500 with operators : ~ > >= < <= IN NOT IN AND OR and negation prefix - - Object (JSON): {"name":{"$like":"value"}} with operators $eq, $like, $lt, $lte, $gt, $gte, $in, $nin, $and, $or, $not - Bracket notation: ?filter[name][$like]=value - Relationship traversal: ?filter[relationship][$exists]=true or ?filter[relationship][field]=value

Response

Successful Response

datalist of objects

paginationobjectOptional

Pagination information.

sortstringOptional

The field on which the results are sorted.

filtermap from strings to anyOptional

Filtering information.

group_countsmap from strings to integersOptional

Errors

422

Unprocessable Entity Error