Libraries

Get libraries

Returns a list of libraries matching the given filters, including only the requested fields.

get/api/v1/library

Request

  • Base URL: https://cdn.app.axl.tech (the document declares no server; this is the origin it was published from)
  • URL: https://cdn.app.axl.tech/api/v1/library
  • Auth: API key in header Authorization

Query parameters

idstring

ID

isPublishboolean

Whether the library is published

isFreeboolean

Whether the library is free

gamificationEnabledboolean

Whether gamification is enabled

packageIdstring

Package ID

flowIdstring

Cohort ID

timezoneOffsetMininteger

Time zone offset in minutes

skipEmptyListboolean

Ignore empty lists

itemsTotalinteger

Total items

takeinteger

Number of results per page

skipinteger

Number of records to skip

searchstring

Search phrase

sortNamestring

Property to sort by

sortType'asc' | 'desc'

Sort order

useSortboolean

Apply sorting

useBaseFilterboolean

Use base filter

useItemsTotalboolean

Count total records

softDeletedboolean

Soft-deleted

idsstring[]

List of unique identifiers

fieldsstring

Fields to return, using a flexible GraphQL-style syntax. For example, contact fields: {id,email,firstName} See the sample server response for the full list of fields.

Response

OK

successboolean

True if the error list is empty or missing, false otherwise.

resetTokenboolean

Tells the client that the authentication token must be reset.

Changes

No recorded changes to this operation across all 1 revision of this API.