Skip to main content
GET
/
v0
/
topics
JavaScript
import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const topic of client.topics.list()) {
  console.log(topic.id);
}
{
  "data": [
    {
      "id": "789e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "applicationId": "456e4567-e89b-12d3-a456-426614174000",
      "title": "Code Quality",
      "baseline": 0.85,
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z"
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 1,
    "totalPages": 1
  }
}

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"

​
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 topics

Paginated response containing topics

​
data
Topic · object[]
required
​
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.