Libraries

/libraries/:libraryId

Get a library.

Requires the libraries.read OAuth scope.

get/v1/libraries/{libraryId}

Request

  • Base URL
    api.air.inc (relative, and the document’s source URL is not known)
  • Auth
    • API key in header x-api-key and API key in header x-air-workspace-id
    • or HTTP bearer and API key in header x-air-workspace-id
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Response

Default

idstring
titlestring
accessibility'public' | 'private'

Whether the library is public to the workspace or private

visibility'workspaceMembers' | 'libraryMembers'

Who can see the library — all workspace members or only library members

createdAtstring style
updatedAtstring
descriptionstring

The description of the library. Omitted from the response when unset. colorId and icon are not part of the V1 contract.

Changes

No recorded changes to this operation across all 2 revisions of this API.