Status and Visibility
To manage games and mods via the API we use the fields status and visible. The values of these fields determines what is returned in API requests, so it is important to understand who is authorized to view what content.
Visible attribute states & privileges
Only mods use the visible attribute allowing mod admins to control their availability. Public is the default value:
| Meaning | Value | Description | Modify Authorization | Filter Authorization |
|---|---|---|---|---|
| Hidden | 0 | Resource is hidden and not returned when browsing. If requested directly it will be returned provided the user is an admin or subscribed to the content. All resources are always returned via the /me endpoints. | Game & Mod Admins | Game & Mod Admins |
| Public | 1 | Resource is visible and returned via all endpoints. | Game & Mod Admins | Everyone |
Status attribute states & privileges
Games and mods use the status attribute allowing game admins to control their availability. For mods this is important because it allows game admins to control which mods are available without changing the visible value set by the mod admin. Not accepted is the default value until changed by a game admin, or if a file is added to a mods profile it will be moved to an accepted state (provided the game developer has elected "not to curate" new mods):
| Meaning | Value | Description | Modify Authorization | Filter Authorization |
|---|---|---|---|---|
| Not Accepted | 0 | Resource is not accepted and not returned when browsing. Games will be returned if requested directly provided the user is an admin or the api_key used belongs to the game.Mods will be returned if requested directly provided the user is an admin or subscribed to the content. All resources are always returned via the /me endpoints. | Game Admins Only | Game Admins Only |
| Accepted | 1 | Resource is accepted and returned via all endpoints. | Game Admins Only | Everyone |
| Deleted | 3 | Resource is deleted and only returned via the /me endpoints. | Game Admins Only | Game Admins Only |
Game admin privileges
As a game admin, you can modify your games status to show or hide it from API requests. When a game is not accepted you can still view it provided you are the games admin or using the games api_key. You can call Get User Games endpoint to retrieve all games associated with the authenticated user regardless of their status.
By default mods connected to a game will not be returned if they are hidden or not accepted. As a game admin, you can modify a mods status and visible fields and filter by these values (to view content normal users cannot see). We recommend you only change the status and let mod admins control the visible field.
Mod admin privileges
As a mod admin, you can modify visible to show or hide your mod from API requests. You cannot modify the status of your mod. When a mod is hidden you can still view it provided you are the mods admin or subscribed to the mod. You can call Get User Mods endpoint to retrieve all mods associated with the authenticated user regardless of their status and visible.
Valid status & visibility filters
status=1
status-in=0,1
visible=1
visible-in=0,1
Game Admin Only status & visibility filters
status-not-in=1,2
status-gt=1
visible-not-in=1
visible-st=1
Important Note When Filtering
Due to the requirement of certain status & visible values only being available to administrators. We have restricted the amount of filters available for non-game admins and thus for both of these fields only direct matches = and -in are permitted. Attempting to apply game admin filters without the required permissions will result in a 403 Forbidden error response.