List Universal Actions

List the published actions for one app. Use compact results for discovery or full results for argument details.

GET

Path

Path parameters

stringrequired

The app slug from List Universal Apps.

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Query

Arguments

string

The published app version. Defaults to latest.

App version to search. Defaults to latest.

Default: latest

string

Search action names, slugs, descriptions, operations, and models.

Optional action search text matched against app, action, description, operation, and model.

string

compact or full. Compact omits descriptions, controls, and response schemas.

How much action metadata to return. compact is optimized for agent search; full adds descriptions, the model, controls, and the response schema when available.

Default: compact

compact
full

string

none, required, or all.

How many action argument hints to include. required is the default to support simple one-call execution.

Default: required

none
required
all

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Response fields

idstring

Unique id of the action.

appSlugstring

The app slug used in Universal API routes.

appVersionstring

The resolved published app version.

actionSlugstring

The action slug used in Universal API routes.

namestring

The action's display name.

kindstring

trigger for an action that starts a workflow (add it as a trigger); action for one a step runs.

action
trigger

methodstring

The provider method selected by the action definition.

operationstring

The action operation, such as read or create.

supportsobject

The response controls supported by this action.

queryCapabilitiesobject

Limits and paging capabilities for this action.

requiredArgumentsarray of objects

Arguments the action requires.

optionalArgumentsarray of objects

Arguments the action accepts but does not require, with includeArguments=all.

responseFieldsarray of string

Field keys the action can return.

slugConflictboolean

True when more than one action resolves to this slug.

appIdstring

The app that provides this action. verbosity=full only.

appNamestring

The app's display name. verbosity=full only.

descriptionstring

What the action does. verbosity=full only.

modelstring

The provider model this action uses. verbosity=full only.

controlsobject

Response controls and their defaults. verbosity=full only.

responseSchemaarray of objects

Definitions for fields the action can return. verbosity=full only.

isSchemaDynamicboolean

True when the provider determines the response schema at run time. verbosity=full only.

capabilityKeystring

The Cirra capability key that governs running this action: apps.<app>.<model>.<operation> (Get Capability Catalog). Null when the action declares no operation Cirra can govern, so Cirra does not run it.

actionCapabilityKeystring

The key of a rule for this action alone: apps.<app>.actions.<actionSlug>. It decides before capabilityKey, except that a role's deny always wins.