List executions
POST/v3alpha/executions/search
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​
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
Array [
Array [
]
]
query
object
list limitations and ordering.
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.
default is descending
queries
object[]
Define the criteria to query for.
inConditionsQuery
object
conditions
object[]
Defines the conditions to query for.
request
object
Condition-type to execute if a request on the defined API point happens.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
executionTypeQuery
object
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
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
Body
required
Array [
Array [
]
]
query
object
list limitations and ordering.
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.
default is descending
queries
object[]
Define the criteria to query for.
inConditionsQuery
object
conditions
object[]
Defines the conditions to query for.
request
object
Condition-type to execute if a request on the defined API point happens.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
executionTypeQuery
object
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
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
Body
required
Array [
Array [
]
]
query
object
list limitations and ordering.
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.
default is descending
queries
object[]
Define the criteria to query for.
inConditionsQuery
object
conditions
object[]
Defines the conditions to query for.
request
object
Condition-type to execute if a request on the defined API point happens.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
executionTypeQuery
object
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
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
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
Array [
Array [
]
]
details
object
Details provides information about the returned result including total amount found.
the last time the projection got updated
result
object[]
The result contains the executions, which matched the queries.
Condition
object
request
object
Condition-type to execute if a request on the defined API point happens.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
details
object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
targets
object[]
List of ordered list of targets/includes called during the execution.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-25T13:35:39.404Z"
},
"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-06-25T13:35:39.405Z",
"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
Array [
Array [
]
]
details
object
Details provides information about the returned result including total amount found.
the last time the projection got updated
result
object[]
The result contains the executions, which matched the queries.
Condition
object
request
object
Condition-type to execute if a request on the defined API point happens.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
details
object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
targets
object[]
List of ordered list of targets/includes called during the execution.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-25T13:35:39.407Z"
},
"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-06-25T13:35:39.407Z",
"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
Array [
Array [
]
]
details
object
Details provides information about the returned result including total amount found.
the last time the projection got updated
result
object[]
The result contains the executions, which matched the queries.
Condition
object
request
object
Condition-type to execute if a request on the defined API point happens.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
details
object
Details provide some base information (such as the last change date) of the target.
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
targets
object[]
List of ordered list of targets/includes called during the execution.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
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.
Possible values: non-empty
and <= 1000 characters
GRPC-method as condition.
Possible values: non-empty
and <= 1000 characters
GRPC-service as condition.
All calls to any available service and endpoint as condition.
function
object
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.
Possible values: non-empty
and <= 1000 characters
Event name as condition.
Possible values: non-empty
and <= 1000 characters
Event group as condition, all events under this group.
all events as condition.
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-06-25T13:35:39.409Z"
},
"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-06-25T13:35:39.409Z",
"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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}