Search Actions
POST/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
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.
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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
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[]
actionIdQuery
object
actionNameQuery
object
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
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
current state of the action
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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
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[]
actionIdQuery
object
actionNameQuery
object
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
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
current state of the action
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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
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[]
actionIdQuery
object
actionNameQuery
object
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
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
current state of the action
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
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[]
details
object
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 first event of the object
on create: 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
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
after which time the action will be terminated if not finished
when true, the next action will be called even if this action fails
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-11-13T21:20:30.112Z"
},
"sortingColumn": "ACTION_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-11-13T21:20:30.112Z",
"changeDate": "2024-11-13T21:20:30.112Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
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[]
details
object
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 first event of the object
on create: 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
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
after which time the action will be terminated if not finished
when true, the next action will be called even if this action fails
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-11-13T21:20:30.113Z"
},
"sortingColumn": "ACTION_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-11-13T21:20:30.113Z",
"changeDate": "2024-11-13T21:20:30.113Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
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[]
details
object
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 first event of the object
on create: 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
Possible values: [ACTION_STATE_UNSPECIFIED
, ACTION_STATE_INACTIVE
, ACTION_STATE_ACTIVE
]
Default value: ACTION_STATE_UNSPECIFIED
the state of the action
after which time the action will be terminated if not finished
when true, the next action will be called even if this action fails
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-11-13T21:20:30.113Z"
},
"sortingColumn": "ACTION_FIELD_NAME_UNSPECIFIED",
"result": [
{
"id": "69629023906488334",
"details": {
"sequence": "2",
"creationDate": "2024-11-13T21:20:30.114Z",
"changeDate": "2024-11-13T21:20:30.114Z",
"resourceOwner": "69629023906488334"
},
"state": "ACTION_STATE_UNSPECIFIED",
"name": "log context",
"script": "function log(context, calls){console.log(context)}",
"timeout": "string",
"allowedToFail": true
}
]
}
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"
}
]
}