Skip to main content
GET
List quickstarts

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,
status,
id
Example:

"createdAt"

orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

status
enum<string>

Filter by quickstart status

Available options:
MATERIALS_UPLOAD,
MATERIALS_PROCESSING,
MATERIALS_PROCESSING_FAILED,
TASKS_TOPICS_REVIEW,
KB_PROCESSING,
KB_PROCESSING_FAILED,
KB_REVIEW,
POLICIES_PROCESSING,
POLICIES_PROCESSING_FAILED,
POLICIES_REVIEW,
COMPLETE
Example:

"MATERIALS_UPLOAD"

Response

Successfully retrieved quickstarts

Paginated response containing quickstarts

data
object[]
required
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.