Skip to content
Inkbox

Inkbox

BlogContactDocs
GuidesAPI Reference

Ctrl K

GuidesAPI Reference

Jump to

Note Access Control

Grant and revoke agent identities access to a note. Notes use a per-identity model (no wildcard, unlike contacts). Humans (Clerk JWT) and admin API keys always see every note regardless of grants — the rules below only apply to scoped agent keys.

Agent-created notes are auto-granted to the creating identity on POST /notes. All other grants must be added explicitly by an admin or JWT user.


Grant identity access POST

POST /notes/{note_id}/access

Grant an agent identity read + CRUD access to a note.

Auth: admin API key or Clerk JWT only. A scoped agent cannot grant itself or a peer.

Path parameters

ParameterTypeDescription
note_idUUIDNote ID

Request body

FieldTypeRequiredDescription
identity_idUUIDYesIdentity to grant access to (must belong to the same organization)

Response (201)

JSONJSON

Error responses

StatusDescription
403Caller is a scoped agent (grants require admin or JWT)
404Note or identity not found in your organization
409Identity already has access to this note

Code examples


List access rules GET

GET /notes/{note_id}/access

List the identities granted access to a note. A scoped agent without visibility on the note 404s before reaching the grant listing.

Path parameters

ParameterTypeDescription
note_idUUIDNote ID

Response (200)

JSONJSON

Code examples


Revoke identity access DELETE

DELETE /notes/{note_id}/access/{identity_id}

Revoke an identity's access to a note.

  • Admin API keys and JWT humans may revoke any identity — including the original creator. created_by is a pure audit stamp; revoking the creator's grant makes the note agent-invisible (humans still see it).
  • A claimed agent may only revoke its own grant.

Path parameters

ParameterTypeDescription
note_idUUIDNote ID
identity_idUUIDIdentity whose grant to revoke

Response

204 No Content on success.

Error responses

StatusDescription
403Claimed agent attempted to revoke another identity
404Access rule not found

Code examples


Access rule object

FieldTypeDescription
idUUIDUnique access rule identifier
note_idUUIDThe note this rule grants access to
identity_idUUIDThe agent identity granted access (always non-null)
created_atstringCreation timestamp (ISO 8601)

Inkbox

Copyright © 2026 Inkbox

This site is protected by reCAPTCHA.

Google Privacy Policy and Terms of Service apply.

Website

Inkbox

Copyright © 2026 Inkbox

This site is protected by reCAPTCHA.

Google Privacy Policy and Terms of Service apply.

Website

Note Access Control