> ## Documentation Index > Fetch the complete documentation index at: https://docs.octavehq.com/llms.txt > Use this file to discover all available pages before exploring further. # List Use Cases > List Use Cases ## OpenAPI ````yaml get /api/v2/use-case/list openapi: 3.0.0 info: version: 1.0.0 title: Octave API description: API for Octave workspace management and AI-powered content generation servers: - url: https://app.octavehq.com security: - ApiKeyAuth: [] paths: /api/v2/use-case/list: get: tags: - Use Case summary: List Use Cases description: List Use Cases operationId: listUseCases parameters: - schema: type: string nullable: true description: Text search query required: false description: Text search query name: text in: query - schema: type: number nullable: true default: 10 description: Limit required: false description: Limit name: limit in: query - schema: type: number nullable: true default: 0 description: Offset required: false description: Offset name: offset in: query - schema: type: string nullable: true description: >- Filter by offering OId. Accepts Product, Service, and Solution OIds. required: false description: Filter by offering OId. Accepts Product, Service, and Solution OIds. name: offeringOId in: query - schema: type: string nullable: true description: >- @deprecated Use `offeringOId` instead. Filter by offering OId (Product, Service, or Solution). Kept for backward compatibility. deprecated: true required: false description: >- @deprecated Use `offeringOId` instead. Filter by offering OId (Product, Service, or Solution). Kept for backward compatibility. name: productOId in: query - schema: type: string nullable: true description: Playbook OId required: false description: Playbook OId name: playbookOId in: query - schema: type: array items: type: string description: OIds example: - '123' - '456' required: false description: OIds name: oIds in: query responses: '200': description: Use Case data content: application/json: schema: type: object properties: _metadata: $ref: '#/components/schemas/Metadata' total: type: number description: Total number of use cases data: type: array items: type: object properties: oId: type: string minLength: 1 description: The ID of the use case example: uc_1234 createdAt: type: string format: date-time description: The date and time the use case was created example: '2021-01-01' updatedAt: type: string nullable: true format: date-time description: The date and time the use case was updated example: '2021-01-01' deletedAt: type: string nullable: true format: date-time description: The date and time the use case was deleted example: '2021-01-01' archivedAt: type: string nullable: true format: date-time description: The date and time the use case was archived example: '2021-01-01' name: type: string nullable: true description: The name of the use case example: Use Case Name internalName: type: string nullable: true description: The internal name of the use case example: Use Case Internal Name description: type: string nullable: true description: The description of the use case example: Use Case Description primaryUrl: type: string nullable: true description: The primary URL of the use case example: https://www.use-case.com active: type: boolean default: true description: Whether the use case is active and can be used example: true data: $ref: '#/components/schemas/UseCaseData' user: type: object properties: oId: type: string nullable: true description: User OId firstName: type: string nullable: true description: >- The first name of the user who created the use case example: John lastName: type: string nullable: true description: >- The last name of the user who created the use case example: Doe workspace: type: object properties: oId: type: string nullable: true description: Workspace OId scenarios: type: array nullable: true items: type: string description: Scenarios desiredOutcomes: type: array nullable: true items: type: string description: Desired Outcomes required: - oId - createdAt - user - workspace required: - _metadata - total - data '400': description: Bad request content: application/json: schema: type: object properties: _metadata: $ref: '#/components/schemas/Metadata' message: type: string required: - _metadata - message deprecated: false components: schemas: Metadata: type: object properties: usage: type: number default: 0 example: 0 description: API usage requestId: type: string example: requestId description: Request ID message: type: string example: message description: Message timestamp: type: string example: '2021-01-01T00:00:00.000Z' description: Timestamp required: - requestId - timestamp UseCaseData: type: object nullable: true properties: summary: type: string nullable: true description: Summary scenarios: type: array nullable: true items: type: string description: Scenarios desiredOutcomes: type: array nullable: true items: type: string description: Desired Outcomes businessDrivers: type: array nullable: true items: type: string description: Business Drivers strategicImpact: type: array nullable: true items: type: string description: >- The strategic, business-level benefit realized when this use case is solved well: quantifiable impact on revenue, cost, risk, and/or efficiency, and the broader value to the company. customFields: $ref: '#/components/schemas/CustomDataFields' additionalProperties: type: object additionalProperties: anyOf: - type: string - type: array items: type: string - type: number - type: boolean CustomDataFields: type: array items: $ref: '#/components/schemas/CustomDataFieldItem' CustomDataFieldItem: type: object properties: title: type: string value: type: array items: type: string required: - title - value securitySchemes: ApiKeyAuth: type: apiKey in: header name: api_key ````