List resources

get

https://api.lingohub.com/v2/branches/{branchId}/resources

Returns a cursor-paginated list of the resources in the given project branch. Folders are listed only when the filter has a resource[type] condition; {"where":{"_and":[{"resource[type]":{"_in":["FILE","FOLDER"]}}]}} lists files and folders. Use filter to search and sort resources; iterate by passing next_cursor of the previous page via the cursor query parameter until has_more is false. Requires project-level resource view permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

branchId

string

required

^prb_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Unique identifier of the project branch.

Query Params

filter

object

Filters and sorts the list: URL-encoded JSON of the schema ResourceFilter. where holds exactly one _and or _or with an array of clauses; a clause is another _and/_or or a field with exactly one operator. sort lists fields with + (ascending) or - (descending). An unsupported field, operator or value answers 400 invalid_filter with a pointer into the filter.

Field	Type	Operators	Sort
`resource[format]`	ANDROID_XML \| IOS_STRINGS \| IOS_STRINGSDICT \| IOS_STRINGS_CATALOG \| STANDARD_PROPERTIES \| GETTEXT_PO \| WINDOWS_RESX \| QT_LINGUIST_TS \| DEFINE_PHP \| STANDARD_INI \| STANDARD_ARB \| RAILS_YAML \| SYMFONY_YAML \| STANDARD_JSON \| STORYBLOK_JSON \| ANGULAR_TRANSLATE_JSON \| CHROME_I18N_JSON \| GO_I18N_JSON \| I18NEXT_JSON \| REACT_INTL_JSON \| STANDARD_CSV \| SINGLE_LANGUAGE_CSV \| KEY_VALUE_CSV \| STANDARD_XLIFF \| STANDARD_XLIFF_2 \| STANDARD_TXT \| TWINE_TXT \| STANDARD_MARKDOWN \| STANDARD_HTML \| FIGMA \| ZENDESK \| STORYBLOK \| CONTENTFUL \| INTERCOM \| ANDROID_MOBILE_SDK \| SUBTITLE_SRT \| SUBTITLE_VTT \| HUBSPOT \| STRIPO \| CRISP_HELPDESK \| DOCX \| PPTX \| ODT \| ODP \| VUE_I18N_JSON	`_eq` `_ne` `_in` `_nin`	–
`resource[id]`	id	`_eq` `_ne` `_in` `_nin`	–
`resource[name]`	text	`_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank`	yes
`resource[path]`	text	`_eq` `_ne` `_like` `_nlike` `_ilike` `_nilike` `_contains` `_ncontains` `_icontains` `_nicontains` `_starts` `_ends` `_blank` `_nblank`	yes
`resource[type]`	FILE \| FOLDER	`_eq` `_ne` `_in` `_nin`	–

cursor

string

Opaque pagination cursor from the next_cursor field of a previous response. Omit for the first page.

limit

int32

1 to 100

Defaults to 20

Maximum number of items to return per page (1-100).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Resources retrieved successfully.

400Invalid cursor or request parameter.

401Invalid or missing API key.

403Insufficient permissions.

404The resource does not exist, or the API key cannot see it.

429The API rate limit was exceeded. Wait for the number of seconds given in the Retry-After header, then retry.

500An unexpected internal server error occurred.

503The service is temporarily unavailable. Retry after the number of seconds in the Retry-After header.