Skip to main content
GET
JavaScript

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

skip
integer
default:0

Number of items to skip before starting to collect the result set.

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

0

limit
integer

Number of items to include in the result set.

Required range: 1 <= x <= 100
Example:

25

orderBy
enum<string>
default:createdAt

Field to order the result set by.

Available options:
createdAt,
modifiedAt,
title,
slug,
type,
environment,
id
Example:

"createdAt"

orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

slug
string

Filter by application slug

Minimum string length: 1
Example:

"customer-support-bot"

type
enum<string>

Filter by application type

Available options:
CHATBOT,
AGENT
Example:

"CHATBOT"

environment
enum<string>
default:DEV

Filter by application environment

Available options:
DEV,
PROD
Example:

"DEV"

humanAnnotationEnabled
boolean

Filter by human annotation enabled status

Example:

true

Response

Successfully retrieved applications

Paginated response containing applications

data
Application · object[]
required
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.