latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Collections - Management

Get collection by ID

Retrieve a specific collection by its unique identifier.

The collection must be accessible to the authenticated user and must be active (not deactivated). This includes:

  • Collections owned by the user
  • Collections shared with the user's teams
  • Organization-wide collections (if user has appropriate permissions)

Note: Inactive (deactivated) collections will return 404 Not Found, even if you have READ permission on them.

Response: Returns a collection object with full details including nested child collections. The response includes the same fields as the list endpoint, but with the complete collection tree structure recursively populated. See the PublicCollectionDTO schema for complete field definitions.

Response Details:

  • The response includes the full collection tree structure with all child collections recursively populated
  • Child collections have the same structure as the parent collection, allowing for nested hierarchies
  • Only active collections are returned (inactive/deactivated collections are filtered out)
  • Fields with null values (parentId, updatedAt) are omitted from the JSON response. This is standard JSON serialization behavior.

Required Permissions: ACCESS_COLLECTION and READ on the collection.

get/public/v1/collections/{collectionId}

Path parameters

collectionIdinteger required

The unique identifier (ID) of the collection to retrieve. This is the same identifier returned in the id field when retrieving collections via GET /public/v1/collections.

Response

200 OK - Collection found and returned successfully

idinteger required
uuidstring uuid required
scope'User' | 'Customer' | 'Featured' required
type'Default' | 'Commodity' | 'Ariba' required
namestring required
countinteger nullable
lanesboolean required
tiersEnabledboolean required
parentIdinteger nullable
updatedAtstring date-time nullable