Skip to main content

Get all permitted

GET 

https://app.tolgee.io/v2/projects

Returns all projects where current user has any permission

Request

Query Parameters

    filterId int64[]

    Filter projects by id

    filterNotId int64[]

    Filter projects without id

    page integer

    Possible values: >= 0

    Zero-based page index (0..N)

    Default value: 0
    size integer

    Possible values: >= 1

    The size of the page to be returned

    Default value: 20
    sort string[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

    search string

Responses

OK

Schema
    _embedded object
    projects object[]
  • Array [
  • avatar object
    largestringrequired
    thumbnailstringrequired
    baseLanguage object
    basebooleanrequired

    Whether is base language of project

    Example: false
    flagEmojistring

    Language flag emoji as UTF-8 emoji

    Example: 🇨🇿
    idint64required
    namestringrequired

    Language name in english

    Example: Czech
    originalNamestring

    Language name in this language

    Example: čeština
    tagstringrequired

    Language tag according to BCP 47 definition

    Example: cs-CZ
    computedPermission objectrequired
    originstringrequired

    Possible values: [ORGANIZATION_BASE, DIRECT, ORGANIZATION_OWNER, NONE, SERVER_ADMIN]

    permissionModel object
    permittedLanguageIdsint64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    Example: [200001,200004]
    scopesstring[]required

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage, tasks.view, tasks.edit]

    Example: ["KEYS_EDIT","TRANSLATIONS_VIEW"]
    stateChangeLanguageIdsint64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    Example: [200001,200004]
    translateLanguageIdsint64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    Example: [200001,200004]
    typestring

    The user's permission type. This field is null if uses granular permissions

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    viewLanguageIdsint64[]

    List of languages user can view. If null, all languages view is permitted.

    Example: [200001,200004]
    permittedLanguageIdsint64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    Example: [200001,200004]
    scopesstring[]required

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage, tasks.view, tasks.edit]

    Example: ["KEYS_EDIT","TRANSLATIONS_VIEW"]
    stateChangeLanguageIdsint64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    Example: [200001,200004]
    translateLanguageIdsint64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    Example: [200001,200004]
    typestring

    The user's permission type. This field is null if uses granular permissions

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    viewLanguageIdsint64[]

    List of languages user can view. If null, all languages view is permitted.

    Example: [200001,200004]
    defaultNamespace object
    idint64required

    The id of namespace

    Example: 10000048
    namestringrequired
    Example: homepage
    descriptionstring
    directPermission object
    permittedLanguageIdsint64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    Example: [200001,200004]
    scopesstring[]required

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage, tasks.view, tasks.edit]

    Example: ["KEYS_EDIT","TRANSLATIONS_VIEW"]
    stateChangeLanguageIdsint64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    Example: [200001,200004]
    translateLanguageIdsint64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    Example: [200001,200004]
    typestring

    The user's permission type. This field is null if uses granular permissions

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    viewLanguageIdsint64[]

    List of languages user can view. If null, all languages view is permitted.

    Example: [200001,200004]
    icuPlaceholdersbooleanrequired

    Whether to disable ICU placeholder visualization in the editor and it's support.

    idint64required
    namestringrequired
    organizationOwner object
    avatar object
    largestringrequired
    thumbnailstringrequired
    basePermissions objectrequired
    permittedLanguageIdsint64[]deprecated

    Deprecated (use translateLanguageIds).

    List of languages current user has TRANSLATE permission to. If null, all languages edition is permitted.

    Example: [200001,200004]
    scopesstring[]required

    Granted scopes to the user. When user has type permissions, this field contains permission scopes of the type.

    Possible values: [translations.view, translations.edit, keys.edit, screenshots.upload, screenshots.delete, screenshots.view, activity.view, languages.edit, admin, project.edit, members.view, members.edit, translation-comments.add, translation-comments.edit, translation-comments.set-state, translations.state-edit, keys.view, keys.delete, keys.create, batch-jobs.view, batch-jobs.cancel, translations.batch-by-tm, translations.batch-machine, content-delivery.manage, content-delivery.publish, webhooks.manage, tasks.view, tasks.edit]

    Example: ["KEYS_EDIT","TRANSLATIONS_VIEW"]
    stateChangeLanguageIdsint64[]

    List of languages user can change state to. If null, changing state of all language values is permitted.

    Example: [200001,200004]
    translateLanguageIdsint64[]

    List of languages user can translate to. If null, all languages editing is permitted.

    Example: [200001,200004]
    typestring

    The user's permission type. This field is null if uses granular permissions

    Possible values: [NONE, VIEW, TRANSLATE, REVIEW, EDIT, MANAGE]

    viewLanguageIdsint64[]

    List of languages user can view. If null, all languages view is permitted.

    Example: [200001,200004]
    descriptionstring
    Example: This is a beautiful organization full of beautiful and clever people
    idint64required
    namestringrequired
    Example: Beautiful organization
    slugstringrequired
    Example: btforg
    organizationRolestring

    Possible values: [MEMBER, OWNER]

    slugstring
    useNamespacesbooleanrequired
  • ]
  • page object
    numberint64
    sizeint64
    totalElementsint64
    totalPagesint64

Authorization: X-API-Key

name: X-API-Keytype: apiKeyin: header

Request Collapse all
Base URL
https://app.tolgee.io
Auth
Parameters
— query
— query
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!