Weblate users API
Added in version 4.0.
Weblate users API is one of 21 APIs that Weblate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include users. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 16 operations across 7 paths, and defines 61 schemas. It is described by OpenAPI 3.1.1.
Requests are made against a single base URL, http:.
16 operations
7 paths
61 schemas
3 DELETE6 GET2 PATCH3 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Weblate users API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Bearer (bearerAuth).
An API key is passed in the cookie as sessionid (cookieAuth).
An API key is passed in the header as Token (tokenAuth).
bearerAuth— Token-based authentication with required prefix Bearer. - Each user has a personal access token which they can get from their respective user profile. These to…cookieAuth— Session-based authentication used when user is signed in.tokenAuth— Token-based authentication with required prefix Token. - Each user has a personal access token which they can get from their respective user profile. These tok…
Paths & Operations 16
Across 7 paths, the API surfaces 16 operations — 3 DELETE, 6 GET, 2 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
users 16
Added in version 4.0.
GET
/api/users/
List of users if you have permissions to see manage users. Without a permission you get to see only your own details.
POST
/api/users/
Create a new user.
GET
/api/users/{username}/
Return information about users.
PUT
/api/users/{username}/
Change the user parameters.
PATCH
/api/users/{username}/
Change the user parameters.
DELETE
/api/users/{username}/
Delete all user information and mark the user inactive.
GET
/api/users/{username}/contributions/
List translation contributions of a user.
POST
/api/users/{username}/groups/
Associate groups with a user.
DELETE
/api/users/{username}/groups/
Remove a user from a group.
GET
/api/users/{username}/notifications/
List subscriptions of a user.
POST
/api/users/{username}/notifications/
Associate subscriptions with a user.
GET
/api/users/{username}/notifications/{subscription_id}/
Get a subscription associated with a user.
PUT
/api/users/{username}/notifications/{subscription_id}/
Edit a subscription associated with a user.
PATCH
/api/users/{username}/notifications/{subscription_id}/
Edit a subscription associated with a user.
DELETE
/api/users/{username}/notifications/{subscription_id}/
Delete a subscription associated with a user.
GET
/api/users/{username}/statistics/
List statistics of a user.
Schemas 61
The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are Component (93 properties), Project (61 properties), Translation (33 properties), PatchedFullUser (16 properties). Each schema is shown below with its type and property counts.
Error415
object
3 properties
3 required
UserGroupDeleteRequest
object
1 property
1 required
ErrorCode406Enum
string
notacceptable - Not Acceptable
Translation
object
33 properties
31 required
Error423
object
3 properties
3 required
ColorEnum
string
navy - Navy blue - Blue aqua - Aqua teal - Teal olive - Olive green - Green lime - Lime yellow - Yellow orange - Orange red - Red maroon - Maroon fuchsia - Fuc…
ErrorResponse403
object
2 properties
2 required
ErrorResponse404
object
2 properties
2 required
ErrorCode429Enum
string
throttled - Throttled
Notification
object
6 properties
6 required
Language
object
10 properties
6 required
SourceEnum
integer
0 - Default plural 1 - gettext plural formula 3 - CLDR plural with zero 4 - CLDR v38+ plural 5 - Android plural 6 - Qt Linguist plural 2 - Manually entered for…
LanguagePlural
object
5 properties
2 required
ErrorCode401Enum
string
authenticationfailed - Authentication Failed notauthenticated - Not Authenticated
ErrorCode403Enum
string
permissiondenied - Permission Denied
ErrorResponse415
object
2 properties
2 required
DirectionEnum
string
- Automatically detect text direction ltr - Left to right rtl - Right to left
Error429
object
3 properties
3 required
NewLangEnum
string
contact - Contact maintainers url - Point to translation instructions URL add - Create new language file none - Disable adding new translations
UserStatistics
object
5 properties
5 required
Error406
object
3 properties
3 required
Error405
object
3 properties
3 required
PatchedFullUser
object
16 properties
Error400
object
3 properties
3 required
Error401
object
3 properties
3 required
FileFormatEnum
string
apple-xliff - XLIFF 1.2 with Apple extensions appstore - App store metadata files arb - ARB file aresource - Android String Resource asciidoc - AsciiDoc file a…
ErrorResponse400TypeEnum
string
validationerror - Validation Error clienterror - Client Error
NotificationScopeEnum
integer
0 - All 10 - Watched 20 - Administered 30 - Project 40 - Component
LanguageCodeStyleEnum
string
- Default based on the file format posix - POSIX style using underscore as a separator posixlowercase - POSIX style using underscore as a separator, lower case…
PriorityEnum
integer
60 - Very high 80 - High 100 - Medium 120 - Low 140 - Very low
Error500
object
3 properties
3 required
Component
object
93 properties
34 required
NotificationEnum
string
RepositoryNotification - Operation was performed in the repository LockNotification - Component was locked or unlocked LicenseNotification - License was change…
ErrorCode500Enum
string
error - Error
CommitPolicyEnum
integer
0 - Commit all translations regardless of quality 20 - Skip translations marked as needing editing 30 - Only include approved translations
ServerErrorEnum
string
servererror - Server Error
ErrorCode415Enum
string
unsupportedmediatype - Unsupported Media Type
Error404
object
3 properties
3 required
Project
object
61 properties
30 required
ErrorCode404Enum
string
notfound - Not Found
ErrorResponse500
object
2 properties
2 required
ErrorResponse423
object
2 properties
2 required
PaginatedFullUserList
object
4 properties
2 required
Error403
object
3 properties
3 required
PaginatedTranslationList
object
4 properties
2 required
ErrorResponse401
object
2 properties
2 required
PatchedNotification
object
6 properties
ErrorResponse429
object
2 properties
2 required
ErrorCode423Enum
string
repository-locked - Repository Locked component-locked - Component Locked unknown-locked - Unknown Locked
PaginatedNotificationList
object
4 properties
2 required
FullUser
object
16 properties
11 required
ErrorResponse400
object
2 properties
2 required
VcsEnum
string
gerrit - Gerrit git - Git git-force-push - Git with force push local - No remote repository mercurial - Mercurial subversion - Subversion
ErrorResponse406
object
2 properties
2 required
ErrorResponse405
object
2 properties
2 required
BlankEnum
FrequencyEnum
integer
0 - No notification 1 - Instant notification 2 - Daily digest 3 - Weekly digest 4 - Monthly digest
MergeStyleEnum
string
merge - Merge rebase - Rebase mergenoff - Merge without fast-forward
UserGroupRequest
object
2 properties
1 required
ErrorCode405Enum
string
methodnotallowed - Method Not Allowed
ClientErrorEnum
string
clienterror - Client Error
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Weblate 12
Other APIs Weblate publishes across the network.
Weblate addons API
Weblate categories API
Weblate changes API
Weblate component-lists API
Weblate components API
Weblate contributions API
Weblate groups API
Weblate hooks API
Weblate languages API
Weblate memory API
Weblate metrics API
Weblate projects API
#users