> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clarifeye.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List artifacts in the catalog

> List the project's artifact catalog (paginated). In-scope artifacts sort
before out-of-scope ones, then by `display_order` and `slug`. Requires
view permission.




## OpenAPI

````yaml /api-reference/openapi-public.yaml get /projects/{project_id}/artifacts/
openapi: 3.0.3
info:
  title: Clarifeye Platform API — Public API
  description: >
    Forward-facing, supported REST API for new integrators of the Clarifeye
    Platform.


    Covers the curated public surface: authentication, knowledge management

    (documents), users & teams, signals, and tool execution. New integrations

    should target these endpoints.


    ## Authentication

    All endpoints require authentication. Include the Authorization header in
    every request using either format:

    - `Authorization: Token <token_key>`

    - `Authorization: Bearer <token_key>`
  version: 1.0.0
  contact:
    name: Clarifeye Support
servers:
  - url: https://eu.app.clarifeye.ai/api/v1
    description: EU
  - url: https://us.app.clarifeye.ai/api/v1
    description: US
security:
  - BearerAuth: []
  - TokenAuth: []
tags:
  - name: Users
    description: Manage users within a project
  - name: Invitations
    description: Manage project invitations
  - name: Documents
    description: Manage documents within a project
  - name: Signals
    description: Submit signals about the project's content for domain experts to review
  - name: Tools
    description: Execute configured AI tools with custom parameters
  - name: Interviews
    description: >-
      Assign, run and review structured interview conversations, and manage
      interview drafts and campaigns
  - name: Artifacts
    description: >
      Knowledge-store artifact catalog: list artifacts, create and edit custom
      artifacts,

      manage scope membership, read and publish versions, and configure the
      cohesion guide.
  - name: Knowledge Changelog
    description: Chronological log of changes to the knowledge store's artifacts.
paths:
  /projects/{project_id}/artifacts/:
    get:
      tags:
        - Artifacts
      summary: List artifacts in the catalog
      description: |
        List the project's artifact catalog (paginated). In-scope artifacts sort
        before out-of-scope ones, then by `display_order` and `slug`. Requires
        view permission.
      operationId: listArtifacts
      parameters:
        - $ref: '#/components/parameters/ProjectId'
        - name: scope
          in: query
          required: false
          schema:
            type: string
            enum:
              - in_scope
              - out_of_scope
              - all
            default: all
          description: Filter by catalog scope membership.
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PaginatedResponse'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/ArtifactSummary'
        '400':
          description: Invalid scope value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    ProjectId:
      name: project_id
      in: path
      required: true
      description: UUID of the project
      schema:
        type: string
        format: uuid
    Limit:
      name: limit
      in: query
      description: Maximum number of results per page
      schema:
        type: integer
        default: 100
        minimum: 1
        maximum: 1000
    Offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
        minimum: 0
  schemas:
    PaginatedResponse:
      type: object
      properties:
        count:
          type: integer
          description: Total number of results
        next:
          type: string
          format: uri
          nullable: true
          description: URL to next page of results
        previous:
          type: string
          format: uri
          nullable: true
          description: URL to previous page of results
        results:
          type: array
          items: {}
    ArtifactSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
        slug:
          type: string
        title:
          type: string
        semantic_type:
          $ref: '#/components/schemas/ArtifactSemanticType'
        technical_type:
          $ref: '#/components/schemas/ArtifactTechnicalType'
        in_scope:
          type: boolean
        display_order:
          type: integer
        group:
          type: string
          description: >
            Catalog group label; empty for predefined artifacts (their section
            derives

            from `semantic_type`) and for ungrouped custom ones. "Foundation"
            and

            "Other" are reserved for UI-derived sections and cannot be set; the
            four

            standard section names ("Project Management", …) are NOT reserved —
            a

            custom artifact may use one to file itself alongside the predefined

            artifacts.
        definition_short:
          type: string
        head_version_number:
          type: integer
          nullable: true
        head_updated_at:
          type: string
          format: date-time
          nullable: true
        version_count:
          type: integer
        can_delete:
          type: boolean
    ArtifactSemanticType:
      type: string
      description: |
        What the artifact means in the knowledge store. Predefined types are
        seeded by the platform; `custom` artifacts are user-created.
      enum:
        - brief
        - project_plan
        - mental_map
        - general_knowledge
        - playbooks
        - library_description
        - design_templates
        - custom
    ArtifactTechnicalType:
      type: string
      description: |
        Storage/editing format of the artifact's payload — string for
        `markdown` and `bpmn_xml`, object for `mental_map`, array for
        `playbook_list` and `design_template_list`.
      enum:
        - markdown
        - mental_map
        - playbook_list
        - design_template_list
        - bpmn_xml
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
      example:
        error: User not found
  responses:
    Unauthorized:
      description: Unauthorized - missing or invalid authentication
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Authentication credentials were not provided.
    Forbidden:
      description: Forbidden - insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: You do not have permission to perform this action.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Use Authorization: Bearer <token>'
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Use Authorization: Token <token>'

````