Skip to main content
GET
/
addons
List addOns
curl --request GET \
  --url https://api.togai.com/addons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "name": "<string>",
      "type": "LICENSE",
      "billableName": "<string>",
      "id": "addon.1zYnCiM9Bpg.1zYn",
      "createdAt": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "displayName": "<string>"
    }
  ],
  "nextToken": "<string>",
  "context": {
    "pageSize": 123,
    "sortOrder": "ASC"
  }
}
​
status
enum
Status of the add-on (`ACTIVE`, `ARCHIVED`)
​
type
enum
Type of the add-on
​
status
string
​
type
string

Allowed filter combinations

  • status
  • type
  • status, type
Fields that can be searched on using _search query param
​
id
string
​
name
string
​
billable_name
string
Fields with which the list response can be sorted using _sort query param
​
created_at
string
​
name
string
​
id
string
Default sort order:name ASC, id ASC

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
status
enum<string>

Filter by status

Available options:
ACTIVE,
ARCHIVED
Example:

"ACTIVE"

​
nextToken
string
Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="

​
pageSize
number
Example:

10

Response

Response for List addons requests

​
data
object[]
required
​
nextToken
string
​
context
object