Synq Docs
Management APIOrgs

Read the org's audit log

Newest first, filtered by action, actor, resource, brand and time. Needs `org.auditLog.view`. Rows are kept as long as the org's plan says: 7, 30 or 365 days, or for ever.

GET/v1/orgs/{org}/audit-log

Newest first, filtered by action, actor, resource, brand and time. Needs org.auditLog.view. Rows are kept as long as the org's plan says: 7, 30 or 365 days, or for ever.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

Query Parameters

limit?integer

At most this many items, 200 at the most.

Range1 <= value <= 200
Default50
cursor?string

The previous page's next_cursor, for the page after it.

action?string

Only this action: org.created, org.updated, org.deleted, org.plan_changed, org.disabled, org.enabled, brand.created, brand.updated, brand.deleted, brand.reply_to_confirmed, brand.app_registrations_full, app.created, app.updated, app.secret_rotated, app.deleted, app.api_access_changed, app.refresh_token_replayed, api.created, api.updated, api.deleted, org.ownership_transferred, member.added, member.role_assigned, member.removed, member.left, role.created, role.updated, role.deleted, invite.created, invite.revoked, invite.accepted, webhook.created, webhook.updated, webhook.secret_rotated, webhook.deleted, webhook.disabled, token_gate.created, token_gate.updated, token_gate.deleted, email_domain.created, email_domain.verified, email_domain.failed, email_domain.deleted, brand.custom_domain_added, brand.custom_domain_verified, brand.custom_domain_activated, brand.custom_domain_failed, brand.custom_domain_suspended, brand.custom_domain_restored, brand.custom_domain_removed, api_key.created, api_key.revoked, change_request.created, change_request.approved, change_request.declined, file.uploaded, file.rejected, file.downloaded, staff.role_granted, user.created, user.updated, user.looked_up, user.email_verified, user.password_reset, user.passkey_added, user.passkey_removed, user.identity_linked, user.identity_unlinked, user.consent_granted, user.consent_revoked, user.api_key_created, user.api_key_revoked, user.sessions_revoked, user.deletion_scheduled, user.deletion_cancelled, user.deleted, user.sign_in_failed, user.token_gate_checked, user.token_gate_dry_run.

actor?string

Only this actor's changes: a user's or an API key's id.

Length1 <= length <= 200
resource?string

Only what happened to this resource: an org's, user's, app's… id.

Length1 <= length <= 200
brand?string

Only in this brand.

since?string

From this time on.

Formatdate-time
until?string

Up to this time.

Formatdate-time

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/orgs/string/audit-log"
{  "data": [    {      "id": "string",      "created_at": "2019-08-24T14:15:22Z",      "action": "string",      "actor": {        "type": "member",        "id": "string"      },      "act_client_id": "string",      "brand_id": "string",      "resource": {        "type": "string",        "id": "string"      },      "metadata": {        "property1": null,        "property2": null      },      "ip": "string",      "user_agent": "string"    }  ],  "next_cursor": "string"}

Delete an org DELETE

At once, nothing serves it: not its routes, its API keys or its brands' issuers. It is purged 30 days later, and its issuer slugs are never used again. Needs `org.delete`, which only the owner has. Recorded as `org.deleted`.

List the org's invoices GET

Its invoices from Stripe, newest first, a page at a time (`after`, the last one's id); none before it has checked out. Needs `org.billing.view`.