Project Grant History

POST 
https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/grants/:grantId/changes/_search

Returns a list of changes/events that have happened on the project grant. It's the history of the project. Make sure to send a limit.

Request

Path Parameters

projectId stringrequired
grantId stringrequired

Query Parameters

query.sequence uint64

sequence represents the order of events. It's always counting

query.limit int64

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 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.

query.asc boolean

default is descending

Header Parameters

x-zitadel-orgid string

The default is always the organization of the requesting user. If you like to change/get objects of another organization include the header. Make sure the requesting user has permission to access the requested data.

Responses

200

A successful response.

application/json

Schema

Schema

result

object[]

Array [

changeDate date-time

the creation date of an event

eventType

object

key string

localizedMessage string

sequence uint64

editorId string

the id of the user who created the event

editorDisplayName string

the display name of the editor

resourceOwnerId string

the organization the event belongs to

editorPreferredLoginName string

the preferred login name of the editor

editorAvatarUrl string

avatar URL of the editor

]

Example (from schema)

{
  "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"
    }
  ]
}

application/grpc

Schema

Schema

result

object[]

Array [

changeDate date-time

the creation date of an event

eventType

object

key string

localizedMessage string

sequence uint64

editorId string

the id of the user who created the event

editorDisplayName string

the display name of the editor

resourceOwnerId string

the organization the event belongs to

editorPreferredLoginName string

the preferred login name of the editor

editorAvatarUrl string

avatar URL of the editor

]

Example (from schema)

{
  "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"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

result

object[]

Array [

changeDate date-time

the creation date of an event

eventType

object

key string

localizedMessage string

sequence uint64

editorId string

the id of the user who created the event

editorDisplayName string

the display name of the editor

resourceOwnerId string

the organization the event belongs to

editorPreferredLoginName string

the preferred login name of the editor

editorAvatarUrl string

avatar URL of the editor

]

Example (from schema)

{
  "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"
    }
  ]
}

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 -X POST 'https://$CUSTOM-DOMAIN/management/v1/projects/:projectId/grants/:grantId/changes/_search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

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

Auth

Bearer Token

Parameters

projectId — pathrequired

grantId — pathrequired

query.sequence — query

query.limit — query

query.asc — query

---truefalse

x-zitadel-orgid — header

ResponseClear

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