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

> Retrieve the schema of a case management table: each field's name, display name, type, and attributes, such as the options of a select field.

# List Fields from Case Management Table



## OpenAPI

````yaml get /workspace/{ws_id}/case_management/table/{table}/fields
openapi: 3.0.1
info:
  title: Blink REST API
  description: >-
    The Blink REST API provides programmatic access to Blink data and
    functionality, enabling the management of resources such as workflows,
    users, cases, and more. Send every request to your own tenant's host,
    https://<your-tenant>.app.blinkops.com/api/v1.
  termsOfService: https://www.blinkops.com/terms-of-use
  contact:
    name: API Support
    url: http://blinkops.com/support
    email: support@blinkops.com
  version: '1.0'
servers:
  - url: https://{tenant}.app.blinkops.com/api/v1
    description: Your Blink tenant
    variables:
      tenant:
        default: your-tenant
        description: >-
          Your Blink tenant name, the part before .app.blinkops.com in your
          browser's address bar when you're logged in to Blink.
security: []
tags:
  - name: Controller
    description: Controller health and stats
  - name: Connections
    description: Manage your connections
  - name: Integrations
    description: Manage your integrations
  - name: Invites
    description: Manage your invites
  - name: Workflows
    description: Create and execute your workflows
  - name: Executions
    description: Get information and manage executions
  - name: Runners
    description: Configure your runners
  - name: Tables
    description: Manage your tables
  - name: Case Management
    description: Manage your cases
  - name: User Settings
    description: Manage user settings
  - name: Webhook
    description: Send to webhook
  - name: workspaces
    description: Manage your workspaces
  - name: User Info
    description: Get Information on current user
  - name: Portal
    description: Manage your portal apps
  - name: Groups
    description: Manage your Groups
  - name: Users
    description: Manage your users
paths:
  /workspace/{ws_id}/case_management/table/{table}/fields:
    get:
      tags:
        - Case Management
      summary: List Fields from Case Management Table
      description: >-
        Retrieve the schema of a case management table: every field, with its
        name, display name, type, and attributes (such as the options of a
        select field). Use it to find the field names to use when you create,
        update, or query records. For the list of out-of-the-box tables, visit
        our [Case Management
        documentation](https://docs.blinkops.com/docs/case-management/managing-cases/managing-cases).
      operationId: CaseManagementListFields
      parameters:
        - name: ws_id
          in: path
          description: Workspace ID
          required: true
          schema:
            type: string
        - name: table
          in: path
          description: Table name
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/api_responses.PagingInfo'
                  - type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: >-
                            #/components/schemas/models.CaseManagementTableFieldDefinition
              example:
                limit: 1000
                offset: 0
                total: 36
                results:
                  - id: cec2cd5f-aa25-4e79-ba96-56092f6ed452
                    created_at: 1768820699332
                    updated_at: 1768820699332
                    created_by: admin@example.com
                    updated_by: admin@example.com
                    tenant_id: <tenant-id>
                    workspace_id: <workspace-id>
                    table_id: <table-id>
                    name: name
                    display_name: Name
                    description: ''
                    type: text
                    attributes:
                      hidden: false
                      protected: true
                      required: true
                      width: 566
                    indexes:
                      - name: cases_name_idx_gin
                        unique: false
                        type: gin
                        class: gin_trgm_ops
                  - id: 7cb362a6-d8e5-4b69-84d5-956d408ada29
                    created_at: 1768820699332
                    updated_at: 1768820699332
                    created_by: admin@example.com
                    updated_by: admin@example.com
                    tenant_id: <tenant-id>
                    workspace_id: <workspace-id>
                    table_id: <table-id>
                    name: status
                    display_name: Status
                    description: ''
                    type: status
                    attributes:
                      options:
                        - OPEN
                        - IN PROGRESS
                        - CLOSED
                      protected: true
                      required: true
                    indexes:
                      - name: cases_status_idx
                        unique: false
                  - id: e3b36560-dde9-4cee-be3f-0bef64a34a8c
                    created_at: 1768820699332
                    updated_at: 1768820699332
                    created_by: admin@example.com
                    updated_by: admin@example.com
                    tenant_id: <tenant-id>
                    workspace_id: <workspace-id>
                    table_id: <table-id>
                    name: severity
                    display_name: Severity
                    description: ''
                    type: risk-level
                    attributes:
                      default_value: 1
                      hidden: false
                      protected: true
                      required: true
                      width: 110
                    indexes:
                      - name: cases_severity_idx
                        unique: false
        '400':
          description: Failed to list records
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/api_responses.ErrorWrapper'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |
            curl --request GET \
              --url 'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields' \
              --header 'BLINK-API-KEY: <api-key>'
        - lang: python
          label: Python
          source: >
            import requests


            url =
            "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields"


            headers = {"BLINK-API-KEY": "<api-key>"}


            response = requests.request("GET", url, headers=headers)


            print(response.text)
        - lang: javascript
          label: JavaScript
          source: >
            const url =
            'https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields';

            const options = {method: 'GET', headers: {'BLINK-API-KEY':
            '<api-key>'}};


            fetch(url, options)
              .then(res => res.json())
              .then(res => console.log(res))
              .catch(err => console.error(err));
        - lang: php
          label: PHP
          source: |
            <?php

            $curl = curl_init();

            curl_setopt_array($curl, [
              CURLOPT_URL => "https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields",
              CURLOPT_RETURNTRANSFER => true,
              CURLOPT_ENCODING => "",
              CURLOPT_MAXREDIRS => 10,
              CURLOPT_TIMEOUT => 30,
              CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
              CURLOPT_CUSTOMREQUEST => "GET",
              CURLOPT_HTTPHEADER => [
                "BLINK-API-KEY: <api-key>"
              ],
            ]);

            $response = curl_exec($curl);
            $err = curl_error($curl);

            curl_close($curl);

            if ($err) {
              echo "cURL Error #:" . $err;
            } else {
              echo $response;
            }
        - lang: go
          label: Go
          source: "package main\n\nimport (\n\t\"fmt\"\n\t\"net/http\"\n\t\"io\"\n)\n\nfunc main() {\n\n\turl := \"https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields\"\n\n\treq, _ := http.NewRequest(\"GET\", url, nil)\n\n\treq.Header.Add(\"BLINK-API-KEY\", \"<api-key>\")\n\n\tres, _ := http.DefaultClient.Do(req)\n\n\tdefer res.Body.Close()\n\tbody, _ := io.ReadAll(res.Body)\n\n\tfmt.Println(res)\n\tfmt.Println(string(body))\n\n}\n"
        - lang: java
          label: Java
          source: >
            HttpResponse<String> response =
            Unirest.get("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields")
              .header("BLINK-API-KEY", "<api-key>")
              .asString();
        - lang: ruby
          label: Ruby
          source: >
            require 'uri'

            require 'net/http'


            url =
            URI("https://<your-tenant>.app.blinkops.com/api/v1/workspace/{ws_id}/case_management/table/{table}/fields")


            http = Net::HTTP.new(url.host, url.port)

            http.use_ssl = true


            request = Net::HTTP::Get.new(url)

            request["BLINK-API-KEY"] = '<api-key>'


            response = http.request(request)

            puts response.read_body
components:
  schemas:
    api_responses.PagingInfo:
      type: object
      properties:
        limit:
          type: integer
        offset:
          type: integer
        total:
          type: integer
    models.CaseManagementTableFieldDefinition:
      type: object
      properties:
        id:
          type: string
          description: Field ID.
        name:
          type: string
          description: Field name, used as the column key in records and RQL queries.
        display_name:
          type: string
          description: Field name shown in the Blink UI.
        description:
          type: string
        type:
          type: string
          description: >-
            Field type, for example `text`, `long-text`, `single-select`,
            `multi-select`, `user`, `reference`, `risk-level`, `status`, or
            `sys-time`.
        attributes:
          type: object
          additionalProperties: true
          description: >-
            Type-specific settings, for example `options` for select fields,
            `required`, `hidden`, `protected`, `default_value`, or
            `table_reference` for reference fields.
        indexes:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/models.CaseManagementTableFieldIndex'
        table_id:
          type: string
        workspace_id:
          type: string
        tenant_id:
          type: string
        created_at:
          type: integer
          description: Creation time, in milliseconds since the Unix epoch.
        updated_at:
          type: integer
          description: Last update time, in milliseconds since the Unix epoch.
        created_by:
          type: string
        updated_by:
          type: string
    api_responses.ErrorWrapper:
      type: object
      properties:
        data:
          type: object
        details:
          type: string
        identifier:
          type: string
        message:
          type: string
        status:
          type: integer
          example: 404
        user_error:
          type: object
    models.CaseManagementTableFieldIndex:
      type: object
      properties:
        name:
          type: string
          description: Index name.
        unique:
          type: boolean
          description: Whether the index enforces unique values.
        type:
          type: string
          description: Index type, for example `gin`. Omitted for the default index type.
        class:
          type: string
          description: Index operator class, for example `gin_trgm_ops`.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Use your API key to access BlinkOps API. To generate an API key, please
        log in to your BlinkOps account and navigate to the API Keys section in
        the user settings page. Add the generated key to your request headers as
        BLINK-API-KEY.
      name: BLINK-API-KEY
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.