List all permission codes

Retrieve a list of user groups with optional filtering, searching, and pagination.

HTTP Request

GET/api/users/permissions/

NOTE: NOT USING THE TRAILING SLASH AT THE END OF THE URL RESULTS TO AN EXTRA REDIRECT WITH 301 STATUS

Authorization

Authorization

• Required: Yes
• Permission: Staff with PermissionPermission or Admin
• Permission Code: 1252
• Authentication: Token-based (Authorization: Token <your_api_key>)

Query Parameters

Parameter	Type	Default	Description
search	String	—	Search term to lookup results by `code` and `name`
ordering	String	—	Order results by (`id`, `name`, `code`). Prefix with '-' for descending order

Example Requests

🐍 Python

1import requests
2
3api = requests.Session()
4api.headers.update({'Authorization': 'Token XXXXXXXXXXXXXXXXXXXXXX'})
5response = api.get('http://www.example.com/api/users/permissions/', params={
6  'ordering': 'code'
7})
8print(response.json())

🌐 Curl

1curl "http://www.example.com/api/users/permissions/?ordering=name" -H "Authorization: Token XXXXXXXXXXXXXXXXXXXXXX"

Response Fields

Field	Type	Description
id	Integer	Unique identifier for the permission
code	Integer	Code of the permission (unique)
name	String	Name of the user group (unique)

Example Response

[
    {
        "id": 9,
        "code": 1001,
        "name": "general_settings_read"
    },
    {
        "id": 10,
        "code": 1002,
        "name": "general_settings_update"
    }
]