Skip to main content

List executions​

List all matching executions. By default, we will return all executions of your instance. Make sure to include a limit and sorting for pagination.

Request Body required
    query object

    list limitations and ordering.

    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

    queries object[]

    Define the criteria to query for.

  • Array [
    • inConditionsQuery object
    conditions object[]

    Defines the conditions to query for.

  • Array [
    • request object

    Condition-type to execute if a request on the defined API point happens.

    method string

    Possible values: non-empty and <= 1000 characters

    GRPC-method as condition.

    service string

    Possible values: non-empty and <= 1000 characters

    GRPC-service as condition.

    all boolean

    All calls to any available service and endpoint as condition.

    response object

    Condition-type to execute on response if a request on the defined API point happens.

    method string

    Possible values: non-empty and <= 1000 characters

    GRPC-method as condition.

    service string

    Possible values: non-empty and <= 1000 characters

    GRPC-service as condition.

    all boolean

    All calls to any available service and endpoint as condition.

    function string

    Condition-type to execute if function is used, replaces actions v1.

    event object

    Condition-type to execute if an event is created in the system.

    event string

    Possible values: non-empty and <= 1000 characters

    Event name as condition.

    group string

    Possible values: non-empty and <= 1000 characters

    Event group as condition, all events under this group.

    all boolean

    all events as condition.

  • ]
    • executionTypeQuery object
    executionType string

    Possible values: [EXECUTION_TYPE_UNSPECIFIED, EXECUTION_TYPE_REQUEST, EXECUTION_TYPE_RESPONSE, EXECUTION_TYPE_EVENT, EXECUTION_TYPE_FUNCTION]

    Default value: EXECUTION_TYPE_UNSPECIFIED

    Defines the type to query for.

    targetQuery object
    targetId string

    the id of the targets to include

    includeQuery object
    include string

    the id of the include

  • ]
Responses

A list of all executions matching the query

Schema
    details object

    Details provides information about the returned result including total amount found.

    totalResult uint64
    processedSequence uint64
    timestamp date-time

    the last time the projection got updated

    result object[]

    The result contains the executions, which matched the queries.

  • Array [
    • executionId string
    details object

    Details provide some base information (such as the last change date) of the target.

    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

    changeDate date-time

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

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

    resourceOwner resource_owner is the organization or instance_id an object belongs to
    targets string[]

    Targets which are called in the defined conditions.

    includes string[]

    Included executions with the same condition-types.

  • ]
POST /v3alpha/executions/search

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN
Bearer Token
Content-Type
Body required
{

  "query": {

    "offset": "0",

    "limit": 100,

    "asc": true

  },

  "queries": [

    {

      "inConditionsQuery": {

        "conditions": [

          {

            "request": {

              "method": "/zitadel.session.v2beta.SessionService/ListSessions",

              "service": "zitadel.session.v2beta.SessionService",

              "all": true

            },

            "response": {

              "method": "/zitadel.session.v2beta.SessionService/ListSessions",

              "service": "zitadel.session.v2beta.SessionService",

              "all": true

            },

            "function": "string",

            "event": {

              "event": "user.human.added",

              "group": "user.human",

              "all": true

            }

          }

        ]

      },

      "executionTypeQuery": {

        "executionType": "EXECUTION_TYPE_UNSPECIFIED"

      },

      "targetQuery": {

        "targetId": "69629023906488334"

      },

      "includeQuery": {

        "include": "request.zitadel.session.v2beta.SessionService"

      }

    }

  ]

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/executions/search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "inConditionsQuery": {
        "conditions": [
          {
            "request": {
              "method": "/zitadel.session.v2beta.SessionService/ListSessions",
              "service": "zitadel.session.v2beta.SessionService",
              "all": true
            },
            "response": {
              "method": "/zitadel.session.v2beta.SessionService/ListSessions",
              "service": "zitadel.session.v2beta.SessionService",
              "all": true
            },
            "function": "string",
            "event": {
              "event": "user.human.added",
              "group": "user.human",
              "all": true
            }
          }
        ]
      },
      "executionTypeQuery": {
        "executionType": "EXECUTION_TYPE_UNSPECIFIED"
      },
      "targetQuery": {
        "targetId": "69629023906488334"
      },
      "includeQuery": {
        "include": "request.zitadel.session.v2beta.SessionService"
      }
    }
  ]
}'