Skip to main content

Search Actions

POST 
https://$CUSTOM-DOMAIN/management/v1/actions/_search

Returns a list of actions matching the query. Actions are custom code written in javascript, that can be run at a specified point/flow/trigger in ZITADEL.

Request​

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data.

Body

required

    query

    object

    Object unspecific list filters like offset, limit and asc/desc.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

    sortingColumn the field the result is sorted (string)

    Possible values: [ACTION_FIELD_NAME_UNSPECIFIED, ACTION_FIELD_NAME_NAME, ACTION_FIELD_NAME_ID, ACTION_FIELD_NAME_STATE]

    Default value: ACTION_FIELD_NAME_UNSPECIFIED

    queries

    object[]

  • Array [

    • actionIdQuery

    object

    id string

    actionNameQuery

    object

    name string
    method string

    Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]

    Default value: TEXT_QUERY_METHOD_EQUALS

    defines which text equality method is used

    actionStateQuery

    object

    state string

    Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]

    Default value: ACTION_STATE_UNSPECIFIED

    current state of the action

  • ]

Responses​

A successful response.

Schema

    details

    object

    totalResult uint64
    processedSequence uint64
    viewTimestamp date-time

    the last time the view got updated

    sortingColumn string

    Possible values: [ACTION_FIELD_NAME_UNSPECIFIED, ACTION_FIELD_NAME_NAME, ACTION_FIELD_NAME_ID, ACTION_FIELD_NAME_STATE]

    Default value: ACTION_FIELD_NAME_UNSPECIFIED

    result

    object[]

  • Array [

    • id string

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
    state string

    Possible values: [ACTION_STATE_UNSPECIFIED, ACTION_STATE_INACTIVE, ACTION_STATE_ACTIVE]

    Default value: ACTION_STATE_UNSPECIFIED

    the state of the action

    name string
    script string
    timeout string

    after which time the action will be terminated if not finished

    allowedToFail boolean

    when true, the next action will be called even if this action fails

  • ]

curl -L 'https://$CUSTOM-DOMAIN/management/v1/actions/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ACTION_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "actionIdQuery": {
        "id": "69629023906488334"
      },
      "actionNameQuery": {
        "name": "log",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "actionStateQuery": {
        "state": "ACTION_STATE_UNSPECIFIED"
      }
    }
  ]
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— header
Body required
{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "sortingColumn": "ACTION_FIELD_NAME_UNSPECIFIED",
  "queries": [
    {
      "actionIdQuery": {
        "id": "69629023906488334"
      },
      "actionNameQuery": {
        "name": "log",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      },
      "actionStateQuery": {
        "state": "ACTION_STATE_UNSPECIFIED"
      }
    }
  ]
}
ResponseClear

Click the Send API Request button above and see the response here!