List entities

Retrieves a paginated list of Entities. You can filter results, sort them, and control which fields are returned.

Without the members:pii:read scope, owner email fields are returned as [redacted]. Filtering by owner[email] requires the members:pii:read scope. Without the users:pii:read scope, user entity name and email fields are returned as [redacted].

Use the type[] query parameter to filter by one or more entity types (e.g. type[]=feature&type[]=initiative). Use the fields parameter to request only the fields you need.

Filter availability

Not all filters apply to all entity types. For example, status filtering is only available for types that have a status field (e.g. feature, initiative), and parent[id] only works for types that have a parent relationship.

Use GET /v2/entities/configurations/{type} to check which filters are supported for a specific type. The filters array in the configuration response lists all available filter parameters, their exact query parameter names, and value schemas.

Limitations

  • Only the AND operator is supported when applying multiple filters. OR, NOT, or nested conditions are not supported.
Query Params
string

Cursor for pagination. Use the value from links.next to fetch the next page.

type[]
array of objects

Filter by one or more entity types. Use array notation: type[]=feature&type[]=initiative. Currently supported PM entity types:

  • product
  • component
  • feature
  • subfeature
  • initiative
  • objective
  • keyResult
  • release
  • releaseGroup
  • user
  • company

The exact types available may vary based on the configuration of the workspace.

type[]
fields[]
array of strings

Controls which fields are returned in the response to optimize bandwidth and tailor data to your needs.

Options:

  • Not specified: Returns only fields with non-empty values (default)
  • fields[]=all: Returns all fields, including those with null values
  • fields[]=name&fields[]=status: Returns only the specified fields

For detailed usage, examples, and field discovery, see Response Field Control.

fields[]
string

Filter by entity name

uuid

Filter by owner ID

string

Filter by owner email

uuid

Filter by status ID

string

Filter by status name

boolean

Filter by archived status (true/false)

uuid

Filter by parent PM entity ID

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json