Collection

Retrieve a single Collection by the Collection ID. The Collection may be Private or Shared. Requires the Private and/or Shared Collection Role Privilege.

SecurityOAuth2
Request
path Parameters
collectionId
required
string <uuid> = 36 characters

The Collection Identifier.

Example: f45c87aa-2ff7-4f2c-9c38-9d69554a1c8a
header Parameters
content-type
string
Example: application/json
Authorization
string
Example: Bearer <token>
Responses
200

Successful Request. Collection Created Successfully.

400

One or more required parameters are missing or invalid.

401

Authentication failed (unauthorized).

403

Forbidden. You do not have permissions to perform this action, or your connection information is not correct.

503

The server is too busy to handle the request.

get/collections/{collectionId}
Request samples
Response samples
application/json
{
  • "id": "f45c87aa-2ff7-4f2c-9c38-9d69554a1c8a",
  • "type": "shared",
  • "name": "Fall Jackets 2024",
  • "parent": "a6e4f3ba-5c18-4daa-a630-463420e006bd",
  • "createdBy": {
    },
  • "lastUpdated": {
    },
  • "securityTemplates": [
    ],
  • "contents": {
    }
}