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

# List creative fields in a workspace



## OpenAPI

````yaml https://api.revinel.com/v1/openapi.json get /workspaces/{workspaceId}/fields
openapi: 3.1.1
info:
  title: Revinel API
  version: 1.0.0
  description: >-
    Public surface of the Revinel platform. Consumed by `@revinel/sdk` and
    `@revinel/react`.


    **Errors** are returned as an oRPC envelope: `{ defined: boolean, code:
    string, status: number, message: string, data?: object }`. Input-validation
    failures return HTTP **422** with `code: "INPUT_VALIDATION_FAILED"` and
    `data.fieldErrors` / `data.formErrors`.
servers:
  - url: https://api.revinel.com/v1
security: []
paths:
  /workspaces/{workspaceId}/fields:
    get:
      tags:
        - Fields (Beta)
      summary: List creative fields in a workspace
      operationId: fields.list
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 9007199254740991
            default: 1
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        key:
                          type: string
                          description: >-
                            Machine-readable slug the ad `meta` is keyed by.
                            Derived from the name on create and immutable, so
                            renaming a field never breaks renderers reading the
                            slug.
                        name:
                          type: string
                          description: Human-readable field label.
                        type:
                          enum:
                            - Text
                            - Textarea
                            - Url
                            - Number
                            - Switch
                            - Image
                            - Color
                            - Select
                          type: string
                          description: Input type of the creative field.
                        description:
                          type: string
                          description: >-
                            Help text shown under the input in the creative
                            form.
                        default:
                          type: string
                          description: >-
                            Value pre-filled in the creative form when the field
                            is blank.
                        placeholder:
                          type: string
                          description: Placeholder shown in the creative form input.
                        isRequired:
                          type: boolean
                          description: Whether advertisers must fill this field.
                        order:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: >-
                            Sort position within the creative form. Kept as a
                            dense 0..n-1 sequence: reordering renumbers every
                            field, so sparse values are not preserved.
                        options:
                          type: array
                          items:
                            type: string
                          description: Choices for a `Select` field. Empty for other types.
                        maxLength:
                          anyOf:
                            - type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            - type: 'null'
                          description: >-
                            Max characters for a `Text`/`Textarea` field. Null
                            for no field-specific limit.
                        min:
                          anyOf:
                            - type: number
                            - type: 'null'
                          description: Minimum for a `Number` field. Null for unbounded.
                        max:
                          anyOf:
                            - type: number
                            - type: 'null'
                          description: Maximum for a `Number` field. Null for unbounded.
                        workspaceId:
                          type: string
                        createdAt:
                          type: string
                          format: date-time
                          x-native-type: date
                        updatedAt:
                          type: string
                          format: date-time
                          x-native-type: date
                      required:
                        - id
                        - key
                        - name
                        - type
                        - description
                        - default
                        - placeholder
                        - isRequired
                        - order
                        - options
                        - maxLength
                        - min
                        - max
                        - workspaceId
                        - createdAt
                        - updatedAt
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Total rows across all pages.
                  page:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: The (clamped) page returned.
                  perPage:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Rows per page.
                  pageCount:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Total number of pages.
                required:
                  - items
                  - total
                  - page
                  - perPage
                  - pageCount
        '409':
          description: '409'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: CONFLICT_FIELD
                      status:
                        const: 409
                      message:
                        type: string
                        default: CONFLICT_FIELD
                      data:
                        type: object
                        properties:
                          formErrors:
                            type: array
                            items:
                              type: string
                          fieldErrors:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: array
                              items:
                                type: string
                        required:
                          - formErrors
                          - fieldErrors
                    required:
                      - defined
                      - code
                      - status
                      - message
                      - data
                  - type: object
                    properties:
                      defined:
                        const: false
                      code:
                        type: string
                      status:
                        type: number
                      message:
                        type: string
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
        '422':
          description: '422'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: INPUT_VALIDATION_FAILED
                      status:
                        const: 422
                      message:
                        type: string
                        default: INPUT_VALIDATION_FAILED
                      data:
                        type: object
                        properties:
                          formErrors:
                            type: array
                            items:
                              type: string
                          fieldErrors:
                            type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: array
                              items:
                                type: string
                        required:
                          - formErrors
                          - fieldErrors
                    required:
                      - defined
                      - code
                      - status
                      - message
                      - data
                  - type: object
                    properties:
                      defined:
                        const: false
                      code:
                        type: string
                      status:
                        type: number
                      message:
                        type: string
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message

````