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

# List customer property definitions

> Returns all customer property schema entries for the organization, plus the schema-level `last_updated_at` timestamp and `last_updated_by` account ID of the most recent mutation. Required scope: `customers:ro`.



## OpenAPI

````yaml /api/customer-data-platform/openapi.json post /v1/get_customer_properties_definitions
openapi: 3.0.0
info:
  title: Customer Data Platform API
  description: A service for collecting, storing, and managing end-user data.
  version: 0.0.1
servers:
  - url: https://api.text.com/cdp
    description: Main production server URL
security:
  - PersonalAccessToken: []
  - OAuth2BearerToken:
      - customers:ro
paths:
  /v1/get_customer_properties_definitions:
    post:
      tags:
        - Customer properties
      summary: List customer property definitions
      description: >-
        Returns all customer property schema entries for the organization, plus
        the schema-level `last_updated_at` timestamp and `last_updated_by`
        account ID of the most recent mutation. Required scope: `customers:ro`.
      operationId: listCustomerPropertyDefinitions
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: List of customer properties in the organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomerPropertiesResponse'
        '401':
          description: Invalid access token
        '403':
          description: Insufficient scopes
        '422':
          description: Invalid request body
        '500':
          description: Internal error
      security:
        - PersonalAccessToken: []
        - OAuth2BearerToken:
            - customers:ro
components:
  schemas:
    ListCustomerPropertiesResponse:
      type: object
      required:
        - properties
      properties:
        last_updated_at:
          type: string
          format: date-time
          description: >-
            Timestamp of the most recent create or update operation on the
            organization's customer property schema.
        last_updated_by:
          type: string
          description: Account ID of the actor that last mutated the schema.
        properties:
          type: array
          items:
            $ref: '#/components/schemas/CustomerProperty'
    CustomerProperty:
      type: object
      required:
        - id
        - name
        - type
        - type_configuration
      properties:
        id:
          type: string
          format: uuid
          description: UUID generated by the store.
        name:
          type: string
          maxLength: 128
          description: Human-readable property name, unique within the organization.
        type:
          $ref: '#/components/schemas/CustomerPropertyType'
        type_configuration:
          $ref: '#/components/schemas/CustomerPropertyTypeConfiguration'
        description:
          type: string
          maxLength: 512
    CustomerPropertyType:
      type: string
      enum:
        - bool
        - string
        - number
        - timestamp
        - link
      description: Type of the customer property value. Assigned at creation and immutable.
    CustomerPropertyTypeConfiguration:
      type: object
      description: >-
        Per-type configuration. The `format` field is only applicable to
        properties of type `timestamp`; it must be empty for all other types.
      properties:
        format:
          type: string
          enum:
            - date-time
            - date
            - time
          description: Optional rendering format for timestamp property values.
  securitySchemes:
    PersonalAccessToken:
      description: >-
        Use your `account ID` as the username and your personal access token
        (PAT) as the password, or pass a Base64-encoded value directly in the
        Authorization header. For more information, see the <a
        href="/authentication/personal-access-tokens">personal access tokens
        guide</a>.
      type: http
      scheme: basic
    OAuth2BearerToken:
      description: >-
        This API uses OAuth2 with the implicit grant flow. <a
        href="/authentication/oauth-authorization#implicit-grant">Learn about
        the implicit grant flow.</a>
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://accounts.livechat.com
          scopes: {}
        authorizationCode:
          authorizationUrl: https://accounts.livechat.com
          tokenUrl: https://accounts.livechat.com/token
          scopes: {}

````