get/audit-eventsRead operation

List developer audit events

Use this operation to list developer audit events. It returns only resources visible to the credential and applies the documented filters before producing a bounded, stable page. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Returned events are privacy-reduced and never include credentials, raw secrets, or unrestricted request bodies.

Required scopes

audit:read

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/audit-events?cursor=CURSOR&limit=50&actorId=ACTORID' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/audit-events?cursor=CURSOR&limit=50&actorId=ACTORID', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/audit-events?cursor=CURSOR&limit=50&actorId=ACTORID', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

teamgrid audit-events list \
  --output json

Example response 2xx

{
  "data": [
    "AuditEvent"
  ],
  "meta": {
    "page": {
      "limit": 1,
      "nextCursor": null
    },
    "requestId": "string",
    "retentionDays": 30
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

cursorquerylimitqueryactorIdqueryactorTypequerycreatedAtFromquerycreatedAtToquerycredentialIdqueryeventTypequeryoutcomequeryrequestIdquerysourcequerytargetIdquerytargetTypequery

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Query parameters

cursor

string

Opaque cursor returned in meta.page.nextCursor.

limit

integer

Maximum number of records to return in this page. The response may contain fewer records.

actorId

string

Filter by actor id.

actorType

string

Filter by actor type.

userserviceCredentialsystem

createdAtFrom

string

Include audit events created at or after this time.

createdAtTo

string

Include audit events created at or before this time.

credentialId

string

Filter by credential id.

eventType

string

Filter by audit event type.

outcome

string

Filter by audit outcome.

successdeniedfailure

requestId

string

Filter by request id.

source

string

Filter by event source.

teamgrid-appapi-v1system

targetId

string

Filter by target id.

targetType

string

Filter by target type.

Responses

200A bounded page of resources visible to the credential, with request metadata and an opaque cursor when another page is available.application/json

Response schemaapplication/json

required

array<AuditEvent>

Public API representation of audit event.

required

object

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDlistAuditEventsOpenAPI JSON ↗

Documentation feedbackWas this page useful?