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.

application/json

application/grpc

application/grpc-web+proto

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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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 object
the id of the include
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
]

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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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 object
the id of the include
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
]

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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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 object
the id of the include
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
]

Responses

• 200
• 400
• 403
• 404
• default

---

A list of all executions matching the query

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

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 [
Condition object
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
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 object[]
List of ordered list of targets/includes called during the execution.
Array [
target string
Unique identifier of existing target to call.
include object
Unique identifier of existing execution to include targets of.
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
]
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-05-17T07:53:57.995Z"
  },
  "result": [
    {
      "Condition": {
        "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": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      },
      "details": {
        "sequence": "2",
        "changeDate": "2024-05-17T07:53:57.996Z",
        "resourceOwner": "69629023906488334"
      },
      "targets": [
        {
          "target": "string",
          "include": {
            "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": {
              "name": "string"
            },
            "event": {
              "event": "user.human.added",
              "group": "user.human",
              "all": true
            }
          }
        }
      ]
    }
  ]
}

Schema

Example (from schema)

---

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 [
Condition object
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
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 object[]
List of ordered list of targets/includes called during the execution.
Array [
target string
Unique identifier of existing target to call.
include object
Unique identifier of existing execution to include targets of.
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
]
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-05-17T07:53:57.997Z"
  },
  "result": [
    {
      "Condition": {
        "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": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      },
      "details": {
        "sequence": "2",
        "changeDate": "2024-05-17T07:53:57.997Z",
        "resourceOwner": "69629023906488334"
      },
      "targets": [
        {
          "target": "string",
          "include": {
            "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": {
              "name": "string"
            },
            "event": {
              "event": "user.human.added",
              "group": "user.human",
              "all": true
            }
          }
        }
      ]
    }
  ]
}

Schema

Example (from schema)

---

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 [
Condition object
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
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 object[]
List of ordered list of targets/includes called during the execution.
Array [
target string
Unique identifier of existing target to call.
include object
Unique identifier of existing execution to include targets of.
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 object
Condition-type to execute if function is used, replaces actions v1.
name string
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.
]
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-05-17T07:53:57.998Z"
  },
  "result": [
    {
      "Condition": {
        "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": {
          "name": "string"
        },
        "event": {
          "event": "user.human.added",
          "group": "user.human",
          "all": true
        }
      },
      "details": {
        "sequence": "2",
        "changeDate": "2024-05-17T07:53:57.998Z",
        "resourceOwner": "69629023906488334"
      },
      "targets": [
        {
          "target": "string",
          "include": {
            "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": {
              "name": "string"
            },
            "event": {
              "event": "user.human.added",
              "group": "user.human",
              "all": true
            }
          }
        }
      ]
    }
  ]
}

invalid list query

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the user does not have permission to access the resource.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...