Get Organization History
Returns a list of changes/events that have happened in the organization. It's the history of the organization. Make sure to send a limit.
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.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
query object
Filter possibility for the changes/history of an Object.
sequence uint64sequence represents the order of events. It's always counting
limit int64Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If no limit is set or the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
asc booleandefault is descending
Request Body required
query object
Filter possibility for the changes/history of an Object.
sequence uint64sequence represents the order of events. It's always counting
limit int64Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If no limit is set or the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
asc booleandefault is descending
Request Body required
query object
Filter possibility for the changes/history of an Object.
sequence uint64sequence represents the order of events. It's always counting
limit int64Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If no limit is set or the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.
asc booleandefault is descending
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
result object[]
Array [changeDate date-timethe creation date of an event
eventType object
key stringlocalizedMessage stringsequence uint64editorId stringthe id of the user who created the event
editorDisplayName stringthe display name of the editor
resourceOwnerId stringthe organization the event belongs to
editorPreferredLoginName stringthe preferred login name of the editor
editorAvatarUrl stringavatar URL of the editor
]
{
"result": [
{
"changeDate": "2019-04-01T08:45:00.000000Z",
"eventType": {
"key": "string",
"localizedMessage": "string"
},
"sequence": "2",
"editorId": "69629023906488334",
"editorDisplayName": "Gigi Giraffe",
"resourceOwnerId": "69629023906488334",
"editorPreferredLoginName": "gigi@acme.zitadel.ch",
"editorAvatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
}
]
}
- Schema
- Example (from schema)
Schema
result object[]
Array [changeDate date-timethe creation date of an event
eventType object
key stringlocalizedMessage stringsequence uint64editorId stringthe id of the user who created the event
editorDisplayName stringthe display name of the editor
resourceOwnerId stringthe organization the event belongs to
editorPreferredLoginName stringthe preferred login name of the editor
editorAvatarUrl stringavatar URL of the editor
]
{
"result": [
{
"changeDate": "2019-04-01T08:45:00.000000Z",
"eventType": {
"key": "string",
"localizedMessage": "string"
},
"sequence": "2",
"editorId": "69629023906488334",
"editorDisplayName": "Gigi Giraffe",
"resourceOwnerId": "69629023906488334",
"editorPreferredLoginName": "gigi@acme.zitadel.ch",
"editorAvatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
}
]
}
- Schema
- Example (from schema)
Schema
result object[]
Array [changeDate date-timethe creation date of an event
eventType object
key stringlocalizedMessage stringsequence uint64editorId stringthe id of the user who created the event
editorDisplayName stringthe display name of the editor
resourceOwnerId stringthe organization the event belongs to
editorPreferredLoginName stringthe preferred login name of the editor
editorAvatarUrl stringavatar URL of the editor
]
{
"result": [
{
"changeDate": "2019-04-01T08:45:00.000000Z",
"eventType": {
"key": "string",
"localizedMessage": "string"
},
"sequence": "2",
"editorId": "69629023906488334",
"editorDisplayName": "Gigi Giraffe",
"resourceOwnerId": "69629023906488334",
"editorPreferredLoginName": "gigi@acme.zitadel.ch",
"editorAvatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
}
]
}
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"
}
]
}