Search Events

POST 
https://$CUSTOM-DOMAIN/admin/v1/events/_search

Returns a list of the possible event types in ZITADEL. This is used to filter the event types in the list events request.

Request

application/json

Body

required

sequence uint64

Sequence represents the order of events. It's always counting. If asc is false, the sequence is used as lesser than filter. If asc is true sequence is used as greater than filter. If the sequence is 0 the field is ignored.

limit int64

Maximum amount of events returned.

asc boolean

default is descending sorting order

editorUserId string
eventTypes string[]

The types are filtered by 'or' and must match the type exactly.

aggregateId string
aggregateTypes string[]
resourceOwner string
creationDate date-time

Use from instead.

range

object

since date-time

The events returned are younger than the UTC since date

until date-time

The events returned are older than the UTC until date.

from date-time

If asc is false, the events returned are older than the UTC from date. If asc is true, the events returned are younger than from.

application/grpc

Body

required

sequence uint64

Sequence represents the order of events. It's always counting. If asc is false, the sequence is used as lesser than filter. If asc is true sequence is used as greater than filter. If the sequence is 0 the field is ignored.

limit int64

Maximum amount of events returned.

asc boolean

default is descending sorting order

editorUserId string
eventTypes string[]

The types are filtered by 'or' and must match the type exactly.

aggregateId string
aggregateTypes string[]
resourceOwner string
creationDate date-time

Use from instead.

range

object

since date-time

The events returned are younger than the UTC since date

until date-time

The events returned are older than the UTC until date.

from date-time

If asc is false, the events returned are older than the UTC from date. If asc is true, the events returned are younger than from.

application/grpc-web+proto

Body

required

sequence uint64

Sequence represents the order of events. It's always counting. If asc is false, the sequence is used as lesser than filter. If asc is true sequence is used as greater than filter. If the sequence is 0 the field is ignored.

limit int64

Maximum amount of events returned.

asc boolean

default is descending sorting order

editorUserId string
eventTypes string[]

The types are filtered by 'or' and must match the type exactly.

aggregateId string
aggregateTypes string[]
resourceOwner string
creationDate date-time

Use from instead.

range

object

since date-time

The events returned are younger than the UTC since date

until date-time

The events returned are older than the UTC until date.

from date-time

If asc is false, the events returned are older than the UTC from date. If asc is true, the events returned are younger than from.

Responses

200

A successful response.

application/json

Schema

Schema

events

object[]

Array [

editor

object

userId string

displayName string

service string

aggregate

object

id string

type

object

type string

localized

object

key string

localizedMessage string

resourceOwner string

sequence uint64

creationDate date-time

The timestamp the event occurred

payload object

Payload contains the data of the event.

type

object

type string

localized

object

key string

localizedMessage string

]

Example (from schema)

{
  "events": [
    {
      "editor": {
        "userId": "165617389845094785",
        "displayName": "Minnie Mouse",
        "service": "Management-API"
      },
      "aggregate": {
        "id": "165617850743094785",
        "type": {
          "type": "user",
          "localized": {
            "key": "string",
            "localizedMessage": "string"
          }
        },
        "resourceOwner": "165617850930497249"
      },
      "sequence": "string",
      "creationDate": "2019-04-01T08:45:00.000000Z",
      "payload": {
        "firstName": "Gigi",
        "lastName": "Giraffe",
        "userName": "gigi@zitadel.com",
        "displayName": "Gigi"
      },
      "type": {
        "type": "user.human.added",
        "localized": {
          "key": "string",
          "localizedMessage": "string"
        }
      }
    }
  ]
}

application/grpc

Schema

Schema

events

object[]

Array [

editor

object

userId string

displayName string

service string

aggregate

object

id string

type

object

type string

localized

object

key string

localizedMessage string

resourceOwner string

sequence uint64

creationDate date-time

The timestamp the event occurred

payload object

Payload contains the data of the event.

type

object

type string

localized

object

key string

localizedMessage string

]

Example (from schema)

{
  "events": [
    {
      "editor": {
        "userId": "165617389845094785",
        "displayName": "Minnie Mouse",
        "service": "Management-API"
      },
      "aggregate": {
        "id": "165617850743094785",
        "type": {
          "type": "user",
          "localized": {
            "key": "string",
            "localizedMessage": "string"
          }
        },
        "resourceOwner": "165617850930497249"
      },
      "sequence": "string",
      "creationDate": "2019-04-01T08:45:00.000000Z",
      "payload": {
        "firstName": "Gigi",
        "lastName": "Giraffe",
        "userName": "gigi@zitadel.com",
        "displayName": "Gigi"
      },
      "type": {
        "type": "user.human.added",
        "localized": {
          "key": "string",
          "localizedMessage": "string"
        }
      }
    }
  ]
}

application/grpc-web+proto

Schema

Schema

events

object[]

Array [

editor

object

userId string

displayName string

service string

aggregate

object

id string

type

object

type string

localized

object

key string

localizedMessage string

resourceOwner string

sequence uint64

creationDate date-time

The timestamp the event occurred

payload object

Payload contains the data of the event.

type

object

type string

localized

object

key string

localizedMessage string

]

Example (from schema)

{
  "events": [
    {
      "editor": {
        "userId": "165617389845094785",
        "displayName": "Minnie Mouse",
        "service": "Management-API"
      },
      "aggregate": {
        "id": "165617850743094785",
        "type": {
          "type": "user",
          "localized": {
            "key": "string",
            "localizedMessage": "string"
          }
        },
        "resourceOwner": "165617850930497249"
      },
      "sequence": "string",
      "creationDate": "2019-04-01T08:45:00.000000Z",
      "payload": {
        "firstName": "Gigi",
        "lastName": "Giraffe",
        "userName": "gigi@zitadel.com",
        "displayName": "Gigi"
      },
      "type": {
        "type": "user.human.added",
        "localized": {
          "key": "string",
          "localizedMessage": "string"
        }
      }
    }
  ]
}

403

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

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/events/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "sequence": "2",
  "limit": 20,
  "asc": true,
  "editorUserId": "69629023906488334",
  "eventTypes": [
    "user.human.added",
    "user.machine"
  ],
  "aggregateId": "69629023906488334",
  "aggregateTypes": "user",
  "resourceOwner": "69629023906488334",
  "creationDate": "2019-04-01T08:45:00.000000Z",
  "range": {
    "since": "2019-04-01T08:45:00.000000Z",
    "until": "2019-04-01T08:45:00.000000Z"
  },
  "from": "2019-04-01T08:45:00.000000Z"
}'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Auth

Bearer Token

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "sequence": "2",
  "limit": 20,
  "asc": true,
  "editorUserId": "69629023906488334",
  "eventTypes": [
    "user.human.added",
    "user.machine"
  ],
  "aggregateId": "69629023906488334",
  "aggregateTypes": "user",
  "resourceOwner": "69629023906488334",
  "creationDate": "2019-04-01T08:45:00.000000Z",
  "range": {
    "since": "2019-04-01T08:45:00.000000Z",
    "until": "2019-04-01T08:45:00.000000Z"
  },
  "from": "2019-04-01T08:45:00.000000Z"
}

ResponseClear

Click the Send API Request button above and see the response here!