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

"createdAt"

orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

type
enum<string>
default:KNOWLEDGE

Filter by document type. Defaults to KNOWLEDGE when omitted.

Available options:
KNOWLEDGE,
POLICY
Example:

"KNOWLEDGE"

documentStatus
enum<string>

Filter by document-level status (DocumentV2.status). When omitted, the API defaults to ACTIVE for library queries and skips the filter for quickstart-scoped queries (so DRAFT KB-Review uploads remain visible). Distinct from status below which filters the document's active version status.

Available options:
DRAFT,
ACTIVE
Example:

"ACTIVE"

status
enum<string>[]

Filter by document version status (filters documents by their active version status). Supports multiple values.

Status of the document. Valid options: DRAFT, REVIEW, APPROVED, ARCHIVED, ACTIVE.

Available options:
DRAFT,
REVIEW,
APPROVED,
ARCHIVED,
ACTIVE
Example:

"APPROVED"

tagId
string[]

Filter documents by tag ID

Example:

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

Search in document version title and content

Example:

"API documentation"

scrapeJobId
string<uuid>[]

Filter by scrape job ID. Supports multiple values.

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:

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

fileProcessingId
string<uuid>[]

Filter by source FileProcessing ID (the row that ingested the doc). Supports multiple values, capped at 100.

Maximum array length: 100
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:

"654e7890-e89b-12d3-a456-426614174000"

topicId
string<uuid>

Filter documents by topic ID

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:

"789e1234-e89b-12d3-a456-426614174000"

assignee
string

Filter by assignee user ID

Example:

"user_123456789"

startDate
string<date-time>

Filter documents created after this date (inclusive).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-01-01T00:00:00.000Z"

endDate
string<date-time>

Filter documents created before this date (inclusive).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2024-12-31T23:59:59.999Z"

quickstartId
string<uuid>

Filter documents linked to a specific 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:

"456e7890-e89b-12d3-a456-426614174001"

metadataStep
string

Filter documents whose active version metadata contains this step value.

Maximum string length: 64
Example:

"KNOWLEDGE_BASE_REVIEW"

Response

Successfully retrieved documents

Paginated response containing documents

data
object[]
required
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.