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

# List custom dimension values

> Returns a paginated list of values for the given custom dimension definition. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it. Returns 404 when the custom dimension definition is not found or has been deleted.




## OpenAPI

````yaml /openapi/findity-admin-api.json get /organizations/{organizationId}/customdimensions/{definitionId}/values
openapi: 3.1.0
info:
  title: Findity Admin API
  description: Findity Admin API
  version: 1.0.0
servers:
  - url: https://stage-api.findity.com/api/v1/admin
  - url: https://api.findity.com/api/v1/admin
security:
  - bearerAuth: []
paths:
  /organizations/{organizationId}/customdimensions/{definitionId}/values:
    get:
      tags:
        - Dimensions
      summary: List custom dimension values
      description: >
        Returns a paginated list of values for the given custom dimension
        definition. Returns 403 when the organization does not exist or the
        authenticated user is not an administrator of it. Returns 404 when the
        custom dimension definition is not found or has been deleted.
      operationId: adminListCustomDimensionValues
      parameters:
        - name: organizationId
          in: path
          required: true
          description: >
            String. The organization's internal ID (32-character hex string) or
            its `externalSourceId`. When the value matches the format of an
            internal ID, the internal ID takes precedence.
          schema:
            type: string
            example: 11adfe2a080040e3892ffb89c21ec44e
        - name: definitionId
          in: path
          required: true
          description: >-
            String. The ID of the custom dimension definition whose values to
            list, as returned in the `id` field of the GET definition response.
          schema:
            type: string
            example: abc123def456abc123def456abc123de
        - name: searchText
          in: query
          required: false
          description: >-
            String. Filters values by a partial, case-insensitive match on the
            display text.
          schema:
            type: string
            example: Mark
        - name: sort
          in: query
          required: false
          description: >
            String. Sort order for the results. Format: `field:direction`.
            Supported fields: `value`, `sortOrder`, `startDate`, `endDate`.
            Supported directions: `asc`, `desc`. Defaults to `sortOrder:asc`.
          schema:
            type: string
            example: sortOrder:asc
        - name: locale
          in: query
          required: false
          description: >
            String. Locale code in `language_REGION` format (e.g. `sv_SE`,
            `en_GB`, `de_DE`). Only applies when sorting by `value`. Determines
            the collation used for alphabetical ordering of text values in
            natural sort. Defaults to `sv_SE`. Unknown locale codes fall back to
            Unicode ordering.
          schema:
            type: string
            example: sv_SE
        - name: max
          in: query
          required: false
          description: Integer. Maximum number of results to return per page.
          schema:
            type: integer
            minimum: 1
            maximum: 1000
            default: 10
        - name: offset
          in: query
          required: false
          description: >-
            Integer. Zero-based offset of the first result to return. Used for
            pagination.
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayOfAdminApiCustomDimensionValues'
              example:
                meta:
                  count: 2
                  total: 2
                data:
                  - id: a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
                    value: Marketing
                    sortOrder: 0
                    startDate: null
                    endDate: null
                  - id: b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5
                    value: Sales
                    sortOrder: 1
                    startDate: '2024-01-01T00:00:00Z'
                    endDate: '2024-12-31T23:59:59Z'
        '403':
          description: Forbidden — organization not found or access denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/403Error'
              examples:
                Organization not found or access denied:
                  value:
                    result: error
                    description: Organization not found or access denied
        '404':
          description: >-
            Not found — custom dimension definition does not exist or has been
            deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/404Error'
              examples:
                Custom dimension definition not found:
                  value:
                    result: error
                    code: CUSTOM_DIMENSION_DEFINITION_NOT_FOUND
                    description: Custom dimension definition not found
components:
  schemas:
    ArrayOfAdminApiCustomDimensionValues:
      type: object
      properties:
        meta:
          type: object
          properties:
            count:
              type: integer
              description: Number of dimension values returned in this response page.
            total:
              type: integer
              description: >-
                Total number of dimension values matching the query across all
                pages.
          required:
            - count
            - total
        data:
          type: array
          items:
            $ref: '#/components/schemas/AdminApiCustomDimensionValue'
      required:
        - meta
        - data
    403Error:
      type: object
      properties:
        result:
          type: string
        description:
          type: string
      example:
        result: error
        description: Not allowed
    404Error:
      type: object
      properties:
        result:
          type: string
        code:
          type: string
        description:
          type: string
      example:
        result: error
        code: ORGANIZATION_NOT_FOUND
        description: 'Failed to get organization for id: {orgId}'
    AdminApiCustomDimensionValue:
      type: object
      required:
        - id
        - value
      properties:
        id:
          type: string
          description: Unique identifier of the dimension value.
        value:
          type: string
          description: Display text of the dimension value.
        sortOrder:
          type: integer
          description: Sort position of the value within the list. Null when not set.
          nullable: true
        startDate:
          type: string
          format: date-time
          description: Date from which this value is active. Null when not set.
          nullable: true
        endDate:
          type: string
          format: date-time
          description: Date until which this value is active. Null when not set.
          nullable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````