Introduction

Localazy API reference.

The Localazy API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

TIP: We’re maintaining the @localazy/ts-api library which wraps all the following API resources.

Base url πŸ”—

Localazy API is available at https://api.localazy.com, and all endpoints in this document are relative to this base URL.

https://api.localazy.com

Authentication πŸ”—

Learn how to authenticate with Localazy API

Endpoints reference πŸ”—

Learn what options are available when using Localazy API.

List projects πŸ”—

[GET] /projects

Learn more about Listing projects endpoint

Import content to a project πŸ”—

[POST] /projects/{projectId}/import

Learn how to import content to Localazy via API

List available file types πŸ”—

[GET] /import/formats

Learn how to get a list of available file types for importing strings including their parameters.

List files in project πŸ”—

[GET] /projects/{projectId}/files

Learn how to retrieve a list of all files in the project.

List file content πŸ”—

[GET] /projects/{projectId}/files/{fileId}/keys/{lang}

Learn how to get all translations in a given language via Localazy API

Delete source key πŸ”—

[DELETE] /projects/{projectId}/keys/{keyId}

Learn how to delete a given source key via Localazy API

Update source key πŸ”—

[PUT] /projects/{projectId}/keys/{keyId}

Learn how to change properties of a given source key via Localazy API

List all glossary items πŸ”—

[GET] /projects/{projectId}/glossary

Learn how to retreive all glossary items via Localazy API

Get glossary item πŸ”—

[GET] /projects/{projectId}/glossary/{id}

Learn how to retreive a single glossary item via Localazy API

Delete glossary item πŸ”—

[DELETE] /projects/{projectId}/glossary/{id}

Learn how to delete a glossary item via Localazy API

Create glossary item πŸ”—

[POST] /projects/{projectId}/glossary

Learn how to create new glossary items via Localazy API

Update glossary item πŸ”—

[PUT] /projects/{projectId}/glossary

Learn how to update glossary item via Localazy API

List webhooks configuration πŸ”—

[GET] /projects/{projectid}/webhooks

Learn how to retreive webhook configuration via Localazy API

Update webhooks configuration πŸ”—

[POST] /projects/{projectid}/webhooks

Learn how to add new webhook configuration via Localazy API