Skip to main content

List Aggregate Types

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

Request Body required
  • object
Responses

A successful response.


Schema
  • aggregateTypes object[]
  • Array [
  • type string
  • localized object
  • key string
  • localizedMessage string
  • ]
POST /aggregates/types/_search

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/admin/v1
Bearer Token
Content-Type
Body required
{}
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/admin/v1/aggregates/types/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{}'