Audit Log

Immutable audit trail of all actions taken in your team. Filter by action, resource, actor, or date range.

The Audit Lo object

id string

Log entry ID

action string

Action performed (e.g., ticket.created)

resourceType string

Type of resource affected

resourceId string

ID of the affected resource

actorName string

Name of who performed the action

details object

Additional details about the action

createdAt datetime

When the action occurred

Endpoints

GET List Audit Log

GET /api/v1/teams/{teamId}/audit-log

List Audit Log

List audit log entries with optional filtering.

Query Parameters

action string

Filter by action type

resourceType string

Filter by resource type

actorId string

Filter by actor

startDate string

Start date (ISO 8601)

endDate string

End date (ISO 8601)

page integer

Page number (1-indexed)

Default: 1

pageSize integer

Results per page (max 100)

Default: 20

Code Examples

curl -X GET "https://www.cstar.help/api/v1/teams/{teamId}/audit-log?action=ticket.created" \
  -H "Authorization: Bearer sk_live_your_key"

Responses

200 Audit log entries

{
  "success": true,
  "data": [
    {
      "id": "aud_abc",
      "action": "ticket.created",
      "resourceType": "ticket",
      "resourceId": "tkt_abc",
      "actorName": "Jane Smith",
      "createdAt": "2025-12-10T14:30:00Z"
    }
  ]
}

401 Authentication failed — missing or invalid API key

{
  "success": false,
  "error": {
    "type": "authentication_error",
    "code": "authentication_required",
    "message": "Invalid or expired API key",
    "doc_url": "https://www.cstar.help/developers/api-reference#authentication",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}

403 Insufficient permissions — wrong key type or team access

{
  "success": false,
  "error": {
    "type": "authorization_error",
    "code": "insufficient_permissions",
    "message": "Secret key required for this endpoint",
    "doc_url": "https://www.cstar.help/developers/api-reference#authentication",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}

429 Rate limit exceeded

{
  "success": false,
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 60 seconds",
    "doc_url": "https://www.cstar.help/developers/api-reference#rate-limiting",
    "request_id": "req_abc123"
  },
  "meta": {
    "timestamp": "2025-12-10T14:30:00Z"
  }
}