Describe the current API key actor.

GET 
/me

Describe the current API key actor.

OK

Schema

apiKeyIduuidrequired
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
keyNamestring | nullnullablerequired
Example: CI Deploy Key
keyPrefixstring | nullnullablerequired
Example: ak_live_xxxx
organizationIduuidrequired
Example: 7b1e2c3d-0000-0000-0000-000000000001
scopestringrequired
Possible values: [organization, project]
Example: organization
scopedProjectIduuidnullablerequired
Example: null
permissionsstring[]nullablerequired
Example: ["read:project","write:entry"]
createdByUserIduuidrequired
Example: 9a8b7c6d-0000-0000-0000-000000000002
lastUsedAtdate-timenullablerequired
Example: 2025-01-15T10:30:00Z

Permissions Reference

The permissions array on the API key actor lists the resource-level operations the key is authorized to perform. Each permission is formatted as {action}:{resource}.

A null value means the key has full access to all resources within its scope (organization or project). An explicit array enforces least-privilege — the key can only perform operations listed there.

Available permissions

Permission	What it grants
read:project	Read project metadata, settings, and members
write:project	Create and update projects
delete:project	Delete projects
read:entry	Read entries (bugs, features, tasks) and their details
write:entry	Create and update entries
delete:entry	Delete entries
read:comment	Read comments on entries
write:comment	Create and update comments
delete:comment	Delete comments
read:attachment	Download attachments
write:attachment	Upload attachments
delete:attachment	Delete attachments
read:release	Read releases and their contents
write:release	Create and update releases
delete:release	Delete releases
read:webhook	List outbound webhook subscriptions
write:webhook	Create and update webhook subscriptions
delete:webhook	Delete webhook subscriptions
read:audit	Read audit log events
read:search	Run global search queries
read:snapshot	Read report snapshots
read:agreement	Read agreements and their status
read:wiki	Read wiki pages
read:time_entry	Read time entries
write:time_entry	Create, update, submit, and approve time entries
read:user	Read organization members
write:user	Invite and update organization members
read:project_member	Read project membership
write:project_member	Add and update project members
delete:project_member	Remove project members (not included in the default set)
write:integration_link	Create and upsert integration link records
delete:integration_link	Delete integration link records

Checking your key's capabilities

Call GET /api/v1/me before running your integration to confirm the permissions your key holds. If permissions is null, the key has full org-scoped access. If it is an array, only the listed operations will succeed — all others return HTTP 403.

curl https://app.alignsoft.us/api/v1/me \
  -H "Authorization: Bearer $ALIGN_KEY"