Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Audit Log
Search the full API reference Esc to close

List Audit Log

Audit log · REST API reference

Get support
GET/v1/facilities/{facility_id}/audit-log
Facility-scoped or cross-facility ("all") audit log list.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/audit-log' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · string | stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

pagequery · integer | null

1-based page number, for a numbered pager. Mutually exclusive with `cursor`.

Minimum: 1

sortquery · string | null
orderquery · string

Default: "desc" · Values: "asc", "desc"

actor_idquery · string | null

Format: uuid

actor_typequery · string | null
actionquery · string | null
entity_typequery · string | null
startquery · string | null

Inclusive range start (UTC date). Defaults to 30 days before `end`.

Format: date

endquery · string | null

Inclusive range end (UTC date). Defaults to today.

Format: date

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": [
    {
      "action": "string",
      "actor": {
        "id": "00000000-0000-4000-8000-000000000001",
        "label": "string",
        "type": "string",
        "avatar_url": "string",
        "is_system": false
      },
      "actor_id": "00000000-0000-4000-8000-000000000001",
      "actor_type": "string",
      "created_at": "2026-10-29T12:00:00Z",
      "entity_id": "00000000-0000-4000-8000-000000000001",
      "entity_type": "string",
      "id": "00000000-0000-4000-8000-000000000001",
      "correlation_id": "string",
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "reason_code": "string"
    }
  ],
  "meta": {
    "request_id": "string"
  },
  "pagination": {
    "has_more": false,
    "limit": 0,
    "cursor": "string",
    "total_count": 0
  },
  "metrics": {
    "cards": {},
    "computed_at": "2026-10-29T12:00:00Z",
    "is_stale": false,
    "scope": "facility"
  }
}

application/json

dataAuditLogEntryResponse[]required
Show data schema
actionstringrequired
actorAuditActorSummaryrequired

Resolved, display-ready identity of the actor behind an audit entry.

Show actor schema
avatar_urlstring | null
Show avatar_url schema
string | null
Variant 1: string
string
Variant 2: null
null
idstringrequired

Format: uuid

is_systemboolean

Default: false

labelstringrequired
typestringrequired
actor_idstringrequired

Format: uuid

actor_typestringrequired
correlation_idstring | null
Show correlation_id schema
string | null
Variant 1: string
string
Variant 2: null
null
created_atstringrequired

Format: date-time

entity_idstringrequired

Format: uuid

entity_typestringrequired
facility_idstring | null

Format: uuid

Show facility_id schema
string | null
Variant 1: string
string
Variant 2: null
null
idstringrequired

Format: uuid

reason_codestring | null
Show reason_code schema
string | null
Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll audit log operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

List Audit Log | Facily Developers