search

Search

get/v1/projects/{project_id}/search

Request

  • Base URL: https://api.sonenta.dev
  • URL: https://api.sonenta.dev/v1/projects/{project_id}/search
  • Auth: none declared

Path parameters

project_idstring required

Query parameters

qstring required
namespace_idstring nullable
fieldsstring nullable

Comma-separated scope of which fields q must match, restricting the search PORTÉE. Recognized: name, description, value, namespace. namespace matches keys whose namespace NAME or SLUG contains q (distinct from namespace_id, which filters to one namespace). Absent, empty, or containing no recognized field ⇒ default scope name+description+value (unchanged legacy behavior). Unrecognized values are ignored (no 422).

typestring[] nullable

filter by key type(s) (repeatable)

languagesstring nullable

comma-separated language uuids. Both narrows the translations[] match query AND scopes keys[i].translations to these languages.

surfacestring

Which overlay to search VALUES in (task 1482). 'base' (default) searches the normal translation values. An a11y surface (aria_label|alt_text|screen_reader|plain_language) searches that surface's override values instead (key-name hits are unaffected).

limitinteger
include_deletedboolean

Include recycle-bin keys (soft-deleted). Default FALSE excludes trashed keys from both key hits and value hits — aligned with /keys, /translations and coverage (task 1351).

Response

Successful Response

totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.