List Custom Attributes

Abhinav Raut · Last updated Sep 28, 2026

GET /api/v1/custom-attributes

Authentication

Parameters

Name	Location	Type	Required	Description
applies_to	query	string	No	Return only attributes that apply to this entity, e.g. `contact` or `conversation`. Returns all when empty.

Responses

200

Custom attributes retrieved successfully

Content type: application/json.

Field	Type	Required	Description
status	string	No	example: "success"
data	array of object	No
data[].id	integer	No	example: 1
data[].created_at	string (date-time)	No	example: "2025-08-28T10:00:00Z"
data[].updated_at	string (date-time)	No	example: "2025-08-28T10:00:00Z"
data[].name	string	No	example: "Plan"
data[].description	string	No	example: "Subscription plan of the contact"
data[].applies_to	string	No	example: "contact"
data[].key	string	No	example: "plan"
data[].values	array of string	No	example: ["free", "pro"]
data[].values[]	string
data[].data_type	string	No	example: "list"
data[].regex	string	No	example: ""
data[].regex_hint	string	No	example: ""

401

Unauthorized

Content type: application/json.

Field	Type	Required	Description
status	string	No	example: "error"
message	string	No	Error message example: "Invalid request"
data	unspecified	No	Additional error data nullable: true
error_type	string (enum)	No	enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"]

500

Internal server error

Content type: application/json.

Field	Type	Required	Description
status	string	No	example: "error"
message	string	No	Error message example: "Invalid request"
data	unspecified	No	Additional error data nullable: true
error_type	string (enum)	No	enum: ["GeneralException", "PermissionException", "InputException", "DataException", "NetworkException", "NotFoundException", "ConflictException", "UnauthorizedException", "RateLimitException"]

Specification

Download the complete OpenAPI specification.

OpenAPI definition for this endpoint

openapi: 3.0.0
info:
  title: Libredesk API
  description: >-
    REST API documentation for Libredesk helpdesk system.


    ## Authentication


    The Libredesk API supports two authentication methods:


    ### 1. Basic Authentication

    Use your API key and secret with Basic authentication:

    ```

    Authorization: Basic <base64_encoded_api_key:api_secret>

    ```


    ### 2. Token Authentication  

    Use your API key and secret with token authentication:

    ```

    Authorization: token api_key:api_secret

    ```


    To obtain API credentials, generate them from your agent profile in the
    Libredesk dashboard.
  version: 1.0.0
servers:
  - url: http://localhost:8080
    description: Local development server
security:
  - basicAuth: []
  - tokenAuth: []
paths:
  /api/v1/custom-attributes:
    get:
      tags:
        - Custom attributes
      summary: List Custom Attributes
      operationId: handleGetCustomAttributes
      parameters:
        - name: applies_to
          in: query
          required: false
          schema:
            type: string
          description: >-
            Return only attributes that apply to this entity, e.g. `contact` or
            `conversation`. Returns all when empty.
      responses:
        '200':
          description: Custom attributes retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAttributeListResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - basicAuth: []
        - tokenAuth: []
components:
  schemas:
    CustomAttributeListResponse:
      type: object
      properties:
        status:
          type: string
          example: success
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttribute'
    ErrorResponse:
      type: object
      description: Error response format
      properties:
        status:
          type: string
          example: error
        message:
          type: string
          description: Error message
          example: Invalid request
        data:
          nullable: true
          description: Additional error data
        error_type:
          type: string
          enum:
            - GeneralException
            - PermissionException
            - InputException
            - DataException
            - NetworkException
            - NotFoundException
            - ConflictException
            - UnauthorizedException
            - RateLimitException
    CustomAttribute:
      type: object
      properties:
        id:
          type: integer
          example: 1
        created_at:
          type: string
          format: date-time
          example: '2025-08-28T10:00:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-08-28T10:00:00Z'
        name:
          type: string
          example: Plan
        description:
          type: string
          example: Subscription plan of the contact
        applies_to:
          type: string
          example: contact
        key:
          type: string
          example: plan
        values:
          type: array
          items:
            type: string
          example:
            - free
            - pro
        data_type:
          type: string
          example: list
        regex:
          type: string
          example: ''
        regex_hint:
          type: string
          example: ''
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Basic authentication using base64 encoded API key and secret. Format:
        `Authorization: Basic <base64(api_key:api_secret)>`
    tokenAuth:
      type: apiKey
      name: Authorization
      in: header
      description: >-
        Token authentication using API key and secret. Format: `Authorization:
        token api_key:api_secret`