The Settings Management section of the InvenTree API schema is documented below.
InvenTree API 180¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
settings¶
GET /api/settings/global/¶
Description
API endpoint for accessing a list of global settings objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/GlobalSettings"
},
"type": "array"
}
},
"type": "object"
}
GET /api/settings/global/{key}/¶
Description
Detail view for an individual "global setting" object.
- User must have 'staff' status to view / edit
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
PATCH /api/settings/global/{key}/¶
Description
Detail view for an individual "global setting" object.
- User must have 'staff' status to view / edit
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
PUT /api/settings/global/{key}/¶
Description
Detail view for an individual "global setting" object.
- User must have 'staff' status to view / edit
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"value"
],
"type": "object"
}
GET /api/settings/notification/¶
Description
API endpoint for accessing a list of notification user settings objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/NotificationUserSetting"
},
"type": "array"
}
},
"type": "object"
}
GET /api/settings/notification/{id}/¶
Description
Detail view for an individual "notification user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"method",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
PATCH /api/settings/notification/{id}/¶
Description
Detail view for an individual "notification user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"method",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
PUT /api/settings/notification/{id}/¶
Description
Detail view for an individual "notification user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"method",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"method",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"method",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"method": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"required": true,
"typ": "string",
"type": "string",
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the PluginSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"method": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"required": {
"readOnly": true,
"type": "boolean"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"method",
"model_name",
"name",
"pk",
"required",
"typ",
"type",
"value"
],
"type": "object"
}
GET /api/settings/user/¶
Description
API endpoint for accessing a list of user settings objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/UserSettings"
},
"type": "array"
}
},
"type": "object"
}
GET /api/settings/user/{key}/¶
Description
Detail view for an individual "user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
PATCH /api/settings/user/{key}/¶
Description
Detail view for an individual "user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
PUT /api/settings/user/{key}/¶
Description
Detail view for an individual "user setting" object.
- User can only view / edit settings their own settings objects
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
key |
path | string | No |
Request body
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the request body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
Response 200 OK
{
"api_url": "string",
"choices": "string",
"description": "string",
"key": "string",
"model_name": "string",
"name": "string",
"pk": 0,
"typ": "string",
"type": "string",
"units": "string",
"user": 0,
"value": "string"
}
Schema of the response body
{
"description": "Serializer for the InvenTreeUserSetting model.",
"properties": {
"api_url": {
"readOnly": true,
"type": "string"
},
"choices": {
"readOnly": true,
"type": "string"
},
"description": {
"readOnly": true,
"type": "string"
},
"key": {
"readOnly": true,
"type": "string"
},
"model_name": {
"readOnly": true,
"type": "string"
},
"name": {
"readOnly": true,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"typ": {
"readOnly": true,
"type": "string"
},
"type": {
"readOnly": true,
"type": "string"
},
"units": {
"readOnly": true,
"type": "string"
},
"user": {
"readOnly": true,
"type": "integer"
},
"value": {
"type": "string"
}
},
"required": [
"api_url",
"choices",
"description",
"key",
"model_name",
"name",
"pk",
"typ",
"type",
"units",
"user",
"value"
],
"type": "object"
}
Schemas¶
GlobalSettings¶
| Name | Type |
|---|---|
api_url |
string |
choices |
string |
description |
string |
key |
string |
model_name |
string |
name |
string |
pk |
integer |
typ |
string |
type |
string |
units |
string |
value |
string |
NotificationUserSetting¶
| Name | Type |
|---|---|
api_url |
string |
choices |
string |
description |
string |
key |
string |
method |
string |
model_name |
string |
name |
string |
pk |
integer |
required |
boolean |
typ |
string |
type |
string |
value |
string |
PaginatedGlobalSettingsList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<GlobalSettings> |
PaginatedNotificationUserSettingList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<NotificationUserSetting> |
PaginatedUserSettingsList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<UserSettings> |
PatchedGlobalSettings¶
| Name | Type |
|---|---|
api_url |
string |
choices |
string |
description |
string |
key |
string |
model_name |
string |
name |
string |
pk |
integer |
typ |
string |
type |
string |
units |
string |
value |
string |
PatchedNotificationUserSetting¶
| Name | Type |
|---|---|
api_url |
string |
choices |
string |
description |
string |
key |
string |
method |
string |
model_name |
string |
name |
string |
pk |
integer |
required |
boolean |
typ |
string |
type |
string |
value |
string |
PatchedUserSettings¶
| Name | Type |
|---|---|
api_url |
string |
choices |
string |
description |
string |
key |
string |
model_name |
string |
name |
string |
pk |
integer |
typ |
string |
type |
string |
units |
string |
user |
integer |
value |
string |
UserSettings¶
| Name | Type |
|---|---|
api_url |
string |
choices |
string |
description |
string |
key |
string |
model_name |
string |
name |
string |
pk |
integer |
typ |
string |
type |
string |
units |
string |
user |
integer |
value |
string |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs
For more information: https://docs.inventree.org