Skip to content
Clym

API reference

Audit details

Audit log management and retrieval

List audit logs

GET

List the company's audit log entries, within the retention window.

Query parameters:

Name Type Required Description
property_id string No Filter by property ID.
account_id string No Filter by the acting account ID.
event_kind_id string No Filter by event kind ID.
category_id string No Filter by event category ID.
search string No Free-text search across event content.
created_at_start string No Created on or after this date; clamped to retention cutoff.
created_at_end string No Created on or before this date.
order string No Sort order by creation date.
page integer No Page number for pagination.
limit integer No Number of items per page.
200List of audit logs retrieved successfullyapplication/json
resultobject[]optional
Show properties
idstringoptional
Unique audit log entry ID (EventHub event ID)
eventstringoptional
Event name/code
created_atstringoptional
When the event occurred
paramsobjectnullableoptional
Event-specific parameters (sensitive fields removed)
categoryobjectnullableoptional
Event category information
Show properties
idstringoptional
Category ID
codestringoptional
Category code
namestringoptional
Category display name
event_kindobjectnullableoptional
Event kind/type information
Show properties
idstringoptional
Event kind ID
codestringoptional
Event kind code
namestringoptional
Event kind display name
descriptionstringoptional
Event kind description
sourceobjectnullableoptional
Source information about who/what triggered the event
Show properties
userobjectnullableoptional
Show properties
idstringoptional
User ID
typestringoptional
User type (ACCOUNT, PROFILE, etc.)
companyobjectnullableoptional
Show properties
idstringoptional
Company ID
propertyobjectnullableoptional
Show properties
idstringoptional
Property ID
deviceobjectnullableoptional
Device information (user agent parsed)
Show properties
ipstringoptional
IP address
uaobjectnullableoptional
Parsed user agent information
Show properties
browserstringoptional
versionstringoptional
osstringoptional
platformstringoptional
propertyobjectnullableoptional
Property details (if event relates to a property)
Show properties
idstringoptional
Property ID
namestringoptional
Property name
accountobjectnullableoptional
Account details (if action performed by an account user)
Show properties
idstringoptional
Account ID
emailstringoptional
Account email
first_namestringoptional
First name
last_namestringoptional
Last name
avatar_urlstringnullableoptional
Avatar image URL
metaobjectoptional
Pagination metadata for list responses. Optional fields are omitted when not applicable (e.g. `next_page` is absent on the last page).
Show properties
current_pageintegeroptional
next_pageintegeroptional
Present only when more pages exist.
prev_pageintegeroptional
Present only when current_page > 1.
get/admin/company/audit
GET /api/admin/company/audit HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200List of audit logs retrieved successfully
{
  "result": [{
    "id": "8g4hklji5i07l3g9j17mmkkj1fh7dxyi0",
    "event": "INST_OPS_PROPERTY_CREATED",
    "created_at": "2024-01-15T10:30:45Z",
    "params": {"property_id":"2a8befcd9c41f7a3d51ggee5zb1xrcts","name":"example.com","type":"WEBSITE"},
    "category": {
      "id": "7f3gjkih4h96k2f8i06lljjh0eg6cwxhz",
      "code": "PROPERTY_MANAGEMENT",
      "name": "Property Management"
    },
    "event_kind": {
      "id": "6e2fijhg3g85j1e7h95kkiig9df5bvwgy",
      "code": "PROPERTY_CREATE",
      "name": "Property Created",
      "description": "A new property was created"
    },
    "source": {
      "user": {
        "id": "5d1ehigf2f74i0d6g84jjhhf8ce4auvfx",
        "type": "ACCOUNT"
      },
      "company": {
        "id": "1f19dbcbc7b84be5b40ffcc4ya0zqbtr"
      },
      "property": {
        "id": "2a8befcd9c41f7a3d51ggee5zb1xrcts"
      },
      "device": {
        "ip": "192.168.1.1",
        "ua": {
          "browser": {},
          "version": {},
          "os": {},
          "platform": {}
        }
      }
    },
    "property": {
      "id": "2a8befcd9c41f7a3d51ggee5zb1xrcts",
      "name": "example.com"
    },
    "account": {
      "id": "5d1ehigf2f74i0d6g84jjhhf8ce4auvfx",
      "email": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "avatar_url": "https://cdn.example.com/avatars/user123.jpg"
    }
  }],
  "meta": {
    "current_page": 1,
    "next_page": 2,
    "prev_page": 1
  }
}

Get audit log entry

GET

Get a single audit log entry by ID with full details.

Path parameters:

Name Type Required Description
id string Yes Audit log (EventHub event) ID
200Audit log entry retrieved successfullyapplication/json
resultobjectoptional
An audit log entry representing an action performed in the system
Show properties
idstringoptional
Unique audit log entry ID (EventHub event ID)
eventstringoptional
Event name/code
created_atstringoptional
When the event occurred
paramsobjectnullableoptional
Event-specific parameters (sensitive fields removed)
categoryobjectnullableoptional
Event category information
Show properties
idstringoptional
Category ID
codestringoptional
Category code
namestringoptional
Category display name
event_kindobjectnullableoptional
Event kind/type information
Show properties
idstringoptional
Event kind ID
codestringoptional
Event kind code
namestringoptional
Event kind display name
descriptionstringoptional
Event kind description
sourceobjectnullableoptional
Source information about who/what triggered the event
Show properties
userobjectnullableoptional
Show properties
idstringoptional
User ID
typestringoptional
User type (ACCOUNT, PROFILE, etc.)
companyobjectnullableoptional
Show properties
idstringoptional
Company ID
propertyobjectnullableoptional
Show properties
idstringoptional
Property ID
deviceobjectnullableoptional
Device information (user agent parsed)
Show properties
ipstringoptional
IP address
uaobjectnullableoptional
Parsed user agent information
Show properties
browserstringoptional
versionstringoptional
osstringoptional
platformstringoptional
propertyobjectnullableoptional
Property details (if event relates to a property)
Show properties
idstringoptional
Property ID
namestringoptional
Property name
accountobjectnullableoptional
Account details (if action performed by an account user)
Show properties
idstringoptional
Account ID
emailstringoptional
Account email
first_namestringoptional
First name
last_namestringoptional
Last name
avatar_urlstringnullableoptional
Avatar image URL
get/admin/company/audit/{id}
GET /api/admin/company/audit/{id} HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Audit log entry retrieved successfully
{
  "result": {
    "id": "8g4hklji5i07l3g9j17mmkkj1fh7dxyi0",
    "event": "INST_OPS_PROPERTY_CREATED",
    "created_at": "2024-01-15T10:30:45Z",
    "params": {"property_id":"2a8befcd9c41f7a3d51ggee5zb1xrcts","name":"example.com","type":"WEBSITE"},
    "category": {
      "id": "7f3gjkih4h96k2f8i06lljjh0eg6cwxhz",
      "code": "PROPERTY_MANAGEMENT",
      "name": "Property Management"
    },
    "event_kind": {
      "id": "6e2fijhg3g85j1e7h95kkiig9df5bvwgy",
      "code": "PROPERTY_CREATE",
      "name": "Property Created",
      "description": "A new property was created"
    },
    "source": {
      "user": {
        "id": "5d1ehigf2f74i0d6g84jjhhf8ce4auvfx",
        "type": "ACCOUNT"
      },
      "company": {
        "id": "1f19dbcbc7b84be5b40ffcc4ya0zqbtr"
      },
      "property": {
        "id": "2a8befcd9c41f7a3d51ggee5zb1xrcts"
      },
      "device": {
        "ip": "192.168.1.1",
        "ua": {
          "browser": "Chrome",
          "version": "120.0.0",
          "os": "Windows",
          "platform": "Desktop"
        }
      }
    },
    "property": {
      "id": "2a8befcd9c41f7a3d51ggee5zb1xrcts",
      "name": "example.com"
    },
    "account": {
      "id": "5d1ehigf2f74i0d6g84jjhhf8ce4auvfx",
      "email": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "avatar_url": "https://cdn.example.com/avatars/user123.jpg"
    }
  }
}

© 2026 ClymTermsPrivacy policyCookie policy