Oneprofile Table Column Color Labels API

openapi: 3.2.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: Reference | Oneprofile Table Column Color Labels API
  version: 1.0.42765316646
tags:
- description: 'Endpoints for the org-shared names given to the column tint palette: what this organisation calls each colour. Org-level, not per-table.'
  name: table-column-color-labels
paths:
  /tables/color-labels/:
    get:
      description: 'Get what this organisation calls each column tint. Sparse: a colour that has not been renamed is absent, and the client shows its built-in name.'
      operationId: get_color_labels
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableColumnColorLabelsReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Get column colour names
      tags:
      - table-column-color-labels
    patch:
      description: 'Replace the organisation''s column colour names. Send the whole set: a colour omitted, or given a blank name, reverts to its built-in name.'
      operationId: update_color_labels
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableColumnColorLabelsUpdateSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableColumnColorLabelsReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Rename column colours
      tags:
      - table-column-color-labels
components:
  schemas:
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
      - detail
      title: ForbiddenResponse
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
          - items: {}
            type: array
          - additionalProperties: true
            type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: The type of the error. Useful for frontend code to handle different types of errors.
          title: Type
          type: string
      required:
      - loc
      - msg
      - type
      - input
      title: UnprocessableEntityIssue
      type: object
    TableColumnColorLabelsReadSchema:
      description: What this organisation calls each column tint.
      properties:
        labels:
          additionalProperties:
            type: string
          description: 'Colour token to this organisation''s name for it. SPARSE: a token that is absent has not been renamed, and the client shows its built-in name.'
          propertyNames:
            $ref: '#/components/schemas/TableColumnUIColor'
          title: Labels
          type: object
      required:
      - labels
      title: TableColumnColorLabelsReadSchema
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
      - detail
      title: ServerErrorResponse
      type: object
    TableColumnUIColor:
      description: 'Semantic tint token, shared by a column and by a column GROUP.


        Stored as a token rather than a hex value because the grid renders in both a

        light and a dark theme, and a single stored colour is only legible in one of

        them. The client maps each token to a per-mode value.


        Deliberately excludes teal: the brand primary is used for range selection and

        the anchor outline, so a teal column would read as permanently selected.


        Lives HERE rather than in ``table_column_prefs``, where it started, because

        two domains now need it and the layering only allows one direction. A

        column''s tint is stored in ``table_column_prefs`` (org-shared appearance,

        keyed by column) while a group''s is a field on the group row itself in

        ``table_column``, and ``table_column_prefs`` sits ABOVE ``table_column`` in

        the domain layers, so the token had to move DOWN to be reachable from both.

        ``table_column_prefs.types`` re-exports it, which is why that move touched

        no existing import.


        One enum for both on purpose: a colour token is a shared vocabulary (a team

        agreeing that amber means "needs review" is agreeing about it across

        columns and groups alike) and the organisation''s renaming of the palette

        (``table_column_color_labels``) is keyed by this token, so a second enum

        would give groups colours the rename dialog could not name.'
      enum:
      - gray
      - red
      - orange
      - amber
      - green
      - blue
      - purple
      - pink
      title: TableColumnUIColor
      type: string
    UnprocessableEntityResponse:
      properties:
        detail:
          description: The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message.
          title: Detail
          type: string
        issues:
          description: The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
      - detail
      - issues
      title: UnprocessableEntityResponse
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
      - detail
      title: UnauthorizedResponse
      type: object
    TableColumnColorLabelsUpdateSchema:
      description: Request body replacing the organisation's colour names.
      properties:
        labels:
          additionalProperties:
            maxLength: 40
            type: string
          description: 'The complete set of names. A REPLACE, not a merge: a token omitted here, or given a blank name, goes back to its built-in name.'
          propertyNames:
            $ref: '#/components/schemas/TableColumnUIColor'
          title: Labels
          type: object
      required:
      - labels
      title: TableColumnColorLabelsUpdateSchema
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http