Before you start
Create a personal access token and export it asHYPERLOCALISE_API_KEY in your shell. The token inherits its owner’s current role and project access.
Verify your identity
principal, including token and workspace identifiers, effective permissions, and entitlements. Verify that it identifies the workspace you intended before requesting its resources.
List projects
Archive or delete a project
PATCH /v1/projects/{projectId} with {"active": false} archives a native project. Archived projects don’t count toward your workspace’s project limit and are hidden from the project list in the app. Only the API can restore one, with {"active": true}, and the workspace needs a free project slot to do it.
DELETE /v1/projects/{projectId} deletes a native project, with its strings, translations, and source files. This can’t be undone. You can’t delete the last native project a team glossary is attached to. Attach the glossary to another project first. Both need projects:write.
Read source-file import settings
messageFormat (auto, icu, or i18next), custom placeholderPatterns, segmentation, and format-specific importSettings for HTML, JSON, and Excel. path and branch filter by exact match. Read one file with GET /v1/projects/{projectId}/source-files/{fileId}. Both need strings:read, which comes with files:read.
Read a project’s content sync
sync is null when the project has no sync.
List Queries
limit and offset to page through collections.
Reference and errors
The service exposes its interactive reference and OpenAPI document. The OpenAPI document also covers native-project strings, screenshots, batch review, and key job management. File upload and job creation stay onhyperlocalise.com; see Files and jobs and Strings and key jobs.

