Skip to main content
GET
/
v0
/
documents
/
ids
Get all document IDs
curl --request GET \
  --url https://api.avidoai.com/v0/documents/ids \
  --header 'x-api-key: <api-key>'
{
  "documentIds": [
    "123e4567-e89b-12d3-a456-426614174000",
    "223e4567-e89b-12d3-a456-426614174001",
    "323e4567-e89b-12d3-a456-426614174002"
  ]
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Query Parameters

​
status
enum<string>

Filter by document version status (filters documents by their active version status) Status of the document. Valid options: DRAFT, REVIEW, APPROVED, ARCHIVED.

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

"APPROVED"

​
tags
string[]

Filter by tag names (slugified). Documents must have ALL of these tags

Example:
["api-documentation", "user-guide"]

Response

List of document IDs retrieved successfully

Response containing all document IDs without pagination

​
documentIds
string<uuid>[]
required

Array of all document IDs matching the filter criteria

Example:
[
  "123e4567-e89b-12d3-a456-426614174000",
  "223e4567-e89b-12d3-a456-426614174001",
  "323e4567-e89b-12d3-a456-426614174002"
]
⌘I