Skip to main content

Lists collections

GET 
/api/collections

Lists all document collections the user has access to!

Request​

Query Parameters

    $select string

    Returns only the selected properties. (ex. FirstName, LastName, City)

    $expand string

    Include only the selected objects. (ex. Childrens, Locations)

    $filter string

    Filter the response with OData filter queries.

    $top string

    Number of objects to return. (ex. 25)

    $skip string

    Number of objects to skip in the current order (ex. 50)

    $orderby string

    Define the order by one or more fields (ex. LastModified)

Responses​

Success

Schema
    count int64

    Total items in server

    items object[]nullable

    Items retrieved

  • Array [
    • id uuid

    Collection id (GUID)

    title stringnullable

    Title of the collection

    description stringnullable

    A brief description of the collection

    jobReference stringnullable

    Internal field to track jobs associated to this collection

    accessMode CollectionAccessMode

    Possible values: [Everyone, MembersOnly]

    tags object[]nullable

    List of tags

  • Array [
    • key stringnullable
    value nullable
  • ]
  • ]
    • continuationToken stringnullable

    A continuation token

Loading...