> ## Documentation Index > Fetch the complete documentation index at: https://aspect.inc/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get Collection > Get a collection by ID ## OpenAPI ````yaml /api-reference/openapi.json get /collections/{collection_id} openapi: 3.1.0 info: title: Aspect Platform API description: A FastAPI application for Aspect Platform functionality version: 0.0.0 servers: - url: https://api.aspect.inc security: - BearerAuth: [] - ApiKeyAuth: [] paths: /collections/{collection_id}: get: tags: - Collections summary: Get Collection description: Get a collection by ID operationId: get_Collections_collections_collection_id parameters: - name: collection_id in: path required: true schema: type: string format: uuid title: Collection Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CollectionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: CollectionResponse: properties: id: type: string format: uuid title: Id description: Collection ID name: type: string title: Name description: Collection name description: anyOf: - type: string - type: 'null' title: Description description: Collection description created_by_user_id: anyOf: - type: string format: uuid - type: 'null' title: Created By User Id description: User who created this collection created_by_user: anyOf: - $ref: '#/components/schemas/UserInfo' - type: 'null' description: User who created this collection actions: type: integer title: Actions description: User's permission bitmap on this collection num_assets: type: integer title: Num Assets description: Number of assets in the collection default: 0 num_directories: type: integer title: Num Directories description: Number of directories in the collection default: 0 project_id: type: string format: uuid title: Project Id description: Project ID appearance_settings: $ref: '#/components/schemas/AppearanceSettingsResponse' description: Appearance settings with attachments created: type: string format: date-time title: Created description: Creation timestamp updated: type: string format: date-time title: Updated description: Last update timestamp type: object required: - id - name - actions - project_id - appearance_settings - created - updated title: CollectionResponse description: API response schema for creating a collection HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError UserInfo: properties: id: type: string format: uuid title: Id description: User ID first_name: type: string title: First Name description: User's first name last_name: type: string title: Last Name description: User's last name email: type: string title: Email description: User's email address avatar_url: anyOf: - type: string - type: 'null' title: Avatar Url description: User's avatar URL type: object required: - id - first_name - last_name - email title: UserInfo description: Lightweight user information for API responses AppearanceSettingsResponse: properties: header: $ref: '#/components/schemas/HeaderAppearanceResponse' description: Header appearance settings type: object required: - header title: AppearanceSettingsResponse description: API response for appearance settings ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError HeaderAppearanceResponse: properties: height: $ref: '#/components/schemas/HeaderHeight' description: Height of the header show_icon: type: boolean title: Show Icon description: Whether to show the icon icon: anyOf: - $ref: '#/components/schemas/CustomIconData' - type: 'null' description: Icon data (upload attachment embedded in icon.upload) show_creation_info: type: boolean title: Show Creation Info description: Whether to show creator and item counts show_description: type: boolean title: Show Description description: Whether to show the description show_background: type: boolean title: Show Background description: Whether to show background background_attachment: anyOf: - $ref: '#/components/schemas/AttachmentResponse' - type: 'null' description: Attachment for background image type: object required: - height - show_icon - show_creation_info - show_description - show_background title: HeaderAppearanceResponse description: API response for header appearance settings (with attachments) HeaderHeight: type: string enum: - small - medium - large title: HeaderHeight description: Height options for header display CustomIconData: properties: type: $ref: '#/components/schemas/CustomIconType' description: Type of icon (emoji, upload, color, or url) emoji: anyOf: - type: string - type: 'null' title: Emoji description: Emoji character (if type is emoji) color: anyOf: - type: string - type: 'null' title: Color description: Hex color code (if type is color) url: anyOf: - type: string - type: 'null' title: Url description: External URL (if type is url) upload: anyOf: - $ref: '#/components/schemas/AttachmentResponse' - type: 'null' description: >- Full attachment object (if type is upload, populated by service layer) type: object required: - type title: CustomIconData description: |- Icon data for storage and API responses. Stored in JSONB `icon` column. For upload type icons: - The `upload` field is None in the database - The actual attachment is stored via `icon_attachment_id` FK - Service layer populates `upload` from the attachment when loading AttachmentResponse: properties: id: type: string format: uuid title: Id description: Resource identifier url: anyOf: - type: string - type: 'null' title: Url description: Signed download URL url_expires_at: anyOf: - type: string format: date-time - type: 'null' title: Url Expires At description: When the URL expires user_id: anyOf: - type: string format: uuid - type: 'null' title: User Id description: User who uploaded. None if deleted. filename: type: string title: Filename description: Original filename mime_type: type: string title: Mime Type description: MIME type of the file size_bytes: type: integer title: Size Bytes description: File size in bytes uploaded: type: boolean title: Uploaded description: Whether the file has been uploaded created: type: string format: date-time title: Created description: Created timestamp updated: type: string format: date-time title: Updated description: Updated timestamp type: object required: - id - user_id - filename - mime_type - size_bytes - uploaded - created - updated title: AttachmentResponse description: |- API response schema for an attachment. Inherits id, url, url_expires_at from SignedUrlData. Overrides url and url_expires_at as Optional since attachments may not be uploaded yet. CustomIconType: type: string enum: - emoji - upload - color - url title: CustomIconType description: Type of custom icon securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT in Authorization header. 'Bearer ' prefix optional. ApiKeyAuth: type: apiKey in: header name: Authorization description: Aspect API key (sk_...) in Authorization header. 'Bearer ' optional. ````