Main menu

List all translatable assets in your project

GET https://localise.biz/api/assets 

URI parameters

filter

Filter assets by comma-separated tag names. Match any tag with * and negate tags by prefixing with !

string optional
key

API key - required if not sent in Authorization header

string optional

Request headers

Authorization

API key sent as "Loco <key>" or "Basic <encoded>". See Authentication.

string required if not in query

Response

Array of JSON-encoded Asset objects, taking the following form:

[ {
    "id": "", // Unique asset identifier
    "type": "text", // Content type for translations
    "context": "", // Optional context descriptor
    "notes": "", // Optional notes for translators
    "printf": "", // String formatting style
    "created": "", // Time first added in UTC
    "modified": "", // Time last modified in UTC
    "plurals": 0, // Number of associated plural forms
    "tags": [ /* Array of terms asset is tagged with */ ],
    "aliases": { /* Hash of additional asset identifiers, e.g */ },
    "progress": {
        "translated": 0, // Number of locales for which a translation exists (including those flagged)
        "untranslated": 0, // Number of locales that do not yet have a translation of this asset
        "flagged": 0, // Number of locales whose translations are flagged as requiring attention
    }
} ] 

Try it

Open in test console »


« /api/assets