Skip to main content
GET
/
v0
/
style-guides
List style guides
curl --request GET \
  --url https://api.avidoai.com/v0/style-guides \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 0,
    "totalPages": 0
  }
}

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: x >= 0
Example:

0

​
limit
integer
default:25

Number of items to include in the result set.

Required range: 1 <= x <= 100
Example:

25

​
orderBy
string
default:createdAt

Field to order by in the result set.

Example:

"createdAt"

​
orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

​
applicationSlug
string

Filter style guides by application slug

Example:

"my-application"

Response

Successfully retrieved style guides

Paginated response containing style guides

​
data
Style Guide · object[]
required
​
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.