collection

GET /collections

Changed on

Introspect collection(s) by name, collection id, or version id.

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/collections
  • Auth
    • none
    • or HTTP bearer

Query parameters

namestring

Collection name

collection_idstring

Collection ID

version_idstring

Collection version ID

get_inactivestring

If true, inactive collections will be returned in addition to active ones

Response

Collection(s) with matching name, collection id, or version id.

OR

Changes

    • breaking

      added subschema #1 subschema #2 subschema #3 to the ////// response property oneOf list for the response status

    • breaking

      added subschema #1 subschema #2 subschema #3 to the //// response property oneOf list for the response status

    • breaking

      the ////// response's property type changed from integer to string for status

    • breaking

      the //// response's property type changed from integer to string for status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status