List Aggregate Types

POST 
https://$CUSTOM-DOMAIN/admin/v1/aggregates/types/_search

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

Request

application/json

Body

required

object

application/grpc

Body

required

object

application/grpc-web+proto

Body

required

object

Responses

200

A successful response.

application/json

Schema

Schema

aggregateTypes

object[]

Array [

type string

localized

object

key string

localizedMessage string

]

Example (from schema)

{
  "aggregateTypes": [
    {
      "type": "user",
      "localized": {
        "key": "string",
        "localizedMessage": "string"
      }
    }
  ]
}

application/grpc

Schema

Schema

aggregateTypes

object[]

Array [

type string

localized

object

key string

localizedMessage string

]

Example (from schema)

{
  "aggregateTypes": [
    {
      "type": "user",
      "localized": {
        "key": "string",
        "localizedMessage": "string"
      }
    }
  ]
}

application/grpc-web+proto

Schema

Schema

aggregateTypes

object[]

Array [

type string

localized

object

key string

localizedMessage string

]

Example (from schema)

{
  "aggregateTypes": [
    {
      "type": "user",
      "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/aggregates/types/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{}'

Request Collapse all

Base URL

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

Auth

Bearer Token

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{}

ResponseClear

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