Skip to main content
GET
/
api
/
v1
/
settings
/
licenses
List licenses
curl --request GET \
  --url https://app.aegister.com/api/v1/settings/licenses \
  --header 'X-Aegister-Token: <api-key>'
{
  "error": 0,
  "messages": "<array>",
  "total": 1,
  "data": [
    {
      "id": 123,
      "data": {
        "name": "<string>",
        "description": "<string>"
      }
    }
  ]
}

Authorizations

​
X-Aegister-Token
string
header
required

Query Parameters

​
name
string

Filter by license name (case insensitive contains).

​
order
string
default:-id

Order results by field.

Response

200 - application/json
​
error
integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0
Example:

0

​
messages
array

If error is 1, contains zero or more details on the error.

Example:
[]
​
total
number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Required range: x >= 0
Examples:

20

30

40

​
data
object[]