Skip to main content
GET
List topics for a quickstart

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

id
string<uuid>
required

The unique identifier of the quickstart

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

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. 'taskCount' is sorted in-memory after enrichment in the route handler, so its ordering may change once the full page is materialised.

Available options:
createdAt,
modifiedAt,
title,
status,
id,
taskCount
Example:

"createdAt"

orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

title
string

Filter by topic title (case-insensitive)

Example:

"code quality"

isInScope
string

Filter topics by scope status. When true, only returns in-scope topics. When false, only returns out-of-scope topics.

Example:

"true"

isTasksVerified
string

Filter topics by task verification status. When true, only returns topics where all tasks are verified. When false, only returns unverified topics.

Example:

"false"

isKnowledgeBaseVerified
string

Filter topics by knowledge base verification status. When true, only returns topics where the knowledge base has been verified. When false, only returns unverified topics.

Example:

"false"

isPoliciesVerified
string

Filter topics by policies verification status. When true, only returns topics where the policies have been verified. When false, only returns unverified topics.

Example:

"false"

Response

Successfully retrieved quickstart topics

Paginated response containing topics with conversation statistics and holistic verification count

data
object[]
required
pagination
object
required