Skip to main content
Use this API to find, archive, and delete projects, and to read source-file import settings, content sync status, and Queries. To upload files or create translation jobs, use the separate Files and jobs API.

Before you start

Create a personal access token and export it as HYPERLOCALISE_API_KEY in your shell. The token inherits its owner’s current role and project access.

Verify your identity

The JSON response contains principal, including token and workspace identifiers, effective permissions, and entitlements. Verify that it identifies the workspace you intended before requesting its resources.

List projects

Only accessible projects are returned. Use the returned identifiers when requesting a project’s details.

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

Each file tracked in the project comes back with the settings its uploads are parsed with: 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

This returns the project’s sync with a repository or CMS, as the Sync panel shows it: the provider, the saved settings, the schedule, and the next run. It also returns the 10 most recent runs, newest first, with any pull or merge request each run opened and why a failed run failed. sync is null when the project has no sync.

List Queries

Queries support filters including project, status, type, priority, locale, assignee, and search. Follow the API reference for exact fields and allowed values. Use 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 on hyperlocalise.com; see Files and jobs and Strings and key jobs.

Next

Use Files and jobs to build a translation workflow, or MCP for an agent connection.