Collections

A list of collections

Changed on
get/collections

Request

  • Base URL
    https://try.manyfold.app
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: public, read

Query parameters

pageinteger

Specify which page of results to retrieve.

orderstring

Specify order of results; either by name, creation time, or updated time:

  • name
  • recent
  • updated

Response

Success

@idstring required
@typestring required
totalItemsinteger required

Example response

{
  "@id": "https://example.com/collections",
  "@type": "hydra:Collection",
  "totalItems": 42,
  "member": [
    {
      "@id": "/collections/abc123",
      "name": "Printer Parts"
    }
  ],
  "view": {
    "@id": "https://example.com/collections?page=2",
    "@type": "hydra:PartialCollectionView",
    "first": "https://example.com/collections?page=1",
    "prev": "https://example.com/collections?page=1",
    "next": "https://example.com/collections?page=3",
    "last": "https://example.com/collections?page=10"
  }
}

Changes

    • breaking

      removed the media type application/ld+json for the response with the status

    • info

      added the media type application/vnd.manyfold.v0+json for the response with the status

    • info

      the security scope public was added to the endpoint's security scheme client_credentials

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status