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

# Get a category's properties

> The attributes a listing in this Etsy category can have, with the values each takes and its scales, as Etsy lists them. `deprecated: true` marks a property Etsy still lists but refuses in writes. Fetched from Etsy weekly; `fetched_at` says when. A category Alura has not fetched yet answers 503 with `Retry-After`, never an empty list.

Cost: free.



## OpenAPI

````yaml /openapi.json get /v1/categories/{id}/properties
openapi: 3.1.0
info:
  title: Alura API
  version: 1.0.0
  description: Etsy market research for scripts and AI assistants.
servers:
  - url: https://api.alura.io
security:
  - apiKey: []
paths:
  /v1/categories/{id}/properties:
    get:
      summary: Get a category's properties
      description: >-
        The attributes a listing in this Etsy category can have, with the values
        each takes and its scales, as Etsy lists them. `deprecated: true` marks
        a property Etsy still lists but refuses in writes. Fetched from Etsy
        weekly; `fetched_at` says when. A category Alura has not fetched yet
        answers 503 with `Retry-After`, never an empty list.


        Cost: free.
      operationId: reference.categories.properties
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[1-9][0-9]{0,18}$
            description: Etsy seller-taxonomy ID.
            example: '1062'
        - name: fields
          in: query
          required: false
          description: >-
            Comma-separated dotted paths to return; `id`, `object` and `as_of`
            always come back.
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers:
            Request-Id:
              $ref: '#/components/headers/Request-Id'
            Alura-Credits-Cost:
              $ref: '#/components/headers/Alura-Credits-Cost'
            Alura-Credits-Remaining:
              $ref: '#/components/headers/Alura-Credits-Remaining'
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    const: category_properties
                  category_id:
                    type: string
                    description: Etsy seller-taxonomy ID, as a string.
                  properties:
                    type: array
                    items:
                      type: object
                      properties:
                        property_id:
                          type: string
                          description: Etsy property ID, as a string.
                        name:
                          type: string
                        display_name:
                          type: string
                        is_required:
                          type: boolean
                        supports_attributes:
                          type: boolean
                          description: Settable as a listing attribute.
                        supports_variations:
                          type: boolean
                          description: Usable as a variation property.
                        is_multivalued:
                          type: boolean
                        max_values_allowed:
                          anyOf:
                            - type: integer
                            - type: 'null'
                          description: >-
                            How many values a listing may set; null when Etsy
                            states no limit.
                        deprecated:
                          type: boolean
                          description: Etsy still lists it but refuses it in writes.
                        scales:
                          type: array
                          items:
                            type: object
                            properties:
                              scale_id:
                                type: string
                              display_name:
                                type: string
                              description:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - scale_id
                              - display_name
                              - description
                            additionalProperties: false
                        possible_values:
                          type: array
                          items:
                            type: object
                            properties:
                              value_id:
                                description: >-
                                  Etsy value ID, as a string; null for a value
                                  Etsy has no ID for.
                                type:
                                  - string
                                  - 'null'
                              name:
                                type: string
                              scale_id:
                                description: The scale this value belongs to, or null.
                                type:
                                  - string
                                  - 'null'
                              equal_to:
                                type: array
                                items:
                                  type: string
                                description: >-
                                  Value IDs this value is equal to on other
                                  scales.
                            required:
                              - value_id
                              - name
                              - scale_id
                              - equal_to
                            additionalProperties: false
                        selected_values:
                          type: array
                          items:
                            type: object
                            properties:
                              value_id:
                                description: >-
                                  Etsy value ID, as a string; null for a value
                                  Etsy has no ID for.
                                type:
                                  - string
                                  - 'null'
                              name:
                                type: string
                              scale_id:
                                description: The scale this value belongs to, or null.
                                type:
                                  - string
                                  - 'null'
                              equal_to:
                                type: array
                                items:
                                  type: string
                                description: >-
                                  Value IDs this value is equal to on other
                                  scales.
                            required:
                              - value_id
                              - name
                              - scale_id
                              - equal_to
                            additionalProperties: false
                      required:
                        - property_id
                        - name
                        - display_name
                        - is_required
                        - supports_attributes
                        - supports_variations
                        - is_multivalued
                        - max_values_allowed
                        - deprecated
                        - scales
                        - possible_values
                        - selected_values
                      additionalProperties: false
                    description: >-
                      Etsy's properties for this category; empty when Etsy lists
                      none.
                  fetched_at:
                    type: string
                    description: When Alura last fetched this from Etsy (ISO 8601, UTC).
                required:
                  - object
                  - category_id
                  - properties
                  - fetched_at
                additionalProperties: false
              example:
                object: category_properties
                category_id: '1062'
                properties:
                  - property_id: '200'
                    name: Primary color
                    display_name: Primary color
                    is_required: false
                    supports_attributes: true
                    supports_variations: true
                    is_multivalued: false
                    max_values_allowed: null
                    deprecated: false
                    scales: []
                    possible_values:
                      - value_id: '1'
                        name: Beige
                        scale_id: null
                        equal_to: []
                      - value_id: '2'
                        name: Black
                        scale_id: null
                        equal_to: []
                    selected_values: []
                  - property_id: '100'
                    name: Size
                    display_name: Size
                    is_required: false
                    supports_attributes: false
                    supports_variations: true
                    is_multivalued: false
                    max_values_allowed: null
                    deprecated: true
                    scales:
                      - scale_id: '327'
                        display_name: Fluid ounces
                        description: null
                    possible_values:
                      - value_id: '6339'
                        name: '12'
                        scale_id: '327'
                        equal_to: []
                    selected_values: []
                fetched_at: '2026-10-18T09:12:00.000Z'
        '400':
          $ref: '#/components/responses/Problem400'
        '401':
          $ref: '#/components/responses/Problem401'
        '402':
          $ref: '#/components/responses/Problem402'
        '403':
          $ref: '#/components/responses/Problem403'
        '404':
          $ref: '#/components/responses/Problem404'
        '405':
          $ref: '#/components/responses/Problem405'
        '429':
          $ref: '#/components/responses/Problem429'
        '500':
          $ref: '#/components/responses/Problem500'
        '503':
          $ref: '#/components/responses/Problem503'
      x-codeSamples:
        - lang: bash
          label: cURL
          source: |-
            curl "https://api.alura.io/v1/categories/1062/properties" \
              -H "Authorization: Bearer $ALURA_API_KEY"
        - lang: typescript
          label: TypeScript
          source: >-
            const res = await
            fetch('https://api.alura.io/v1/categories/1062/properties', {
              headers: {
                Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
              },
            });

            console.log(await res.json());
        - lang: python
          label: Python
          source: |-
            import json
            import os
            import urllib.request

            request = urllib.request.Request(
                "https://api.alura.io/v1/categories/1062/properties",
                headers={
                    "Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
                },
            )
            with urllib.request.urlopen(request) as response:
                print(json.load(response))
components:
  headers:
    Request-Id:
      description: '`req_` + ULID; quote it when reporting a problem.'
      schema:
        type: string
    Alura-Credits-Cost:
      description: API credits this call cost.
      schema:
        type: integer
    Alura-Credits-Remaining:
      description: >-
        API credits left in the workspace's monthly allowance, counting calls
        still in flight. Absent when it cannot be read right now.
      schema:
        type: integer
  responses:
    Problem400:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/invalid_request
            title: Invalid request
            status: 400
            code: invalid_request
            detail: Invalid request
            suggestion: Fix the request as the detail says, then send it again.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem401:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/unauthorized
            title: Unauthorized
            status: 401
            code: unauthorized
            detail: Unauthorized
            suggestion: 'Send a valid API key as `Authorization: Bearer alura_sk_...`.'
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem402:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/credits_exhausted
            title: API credits exhausted
            status: 402
            code: credits_exhausted
            detail: API credits exhausted
            suggestion: Upgrade the plan or wait for the monthly reset.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem403:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/plan_required
            title: Plan required
            status: 403
            code: plan_required
            detail: Plan required
            suggestion: Upgrade the workspace plan to use this operation.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem404:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/not_found
            title: Not found
            status: 404
            code: not_found
            detail: Not found
            suggestion: Check the ID, or search for it first.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem405:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/method_not_allowed
            title: Method not allowed
            status: 405
            code: method_not_allowed
            detail: Method not allowed
            suggestion: Use one of the methods in the Allow header.
            retryable: false
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem429:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/rate_limited
            title: Rate limited
            status: 429
            code: rate_limited
            detail: Rate limited
            suggestion: Wait for Retry-After, then retry.
            retryable: true
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem500:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/internal_error
            title: Internal error
            status: 500
            code: internal_error
            detail: Internal error
            suggestion: Retry; if it keeps failing, report the request_id.
            retryable: true
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
    Problem503:
      description: Error
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            type: https://docs.alura.io/errors/credits_unavailable
            title: API credits unavailable
            status: 503
            code: credits_unavailable
            detail: API credits unavailable
            suggestion: Retry shortly.
            retryable: true
            request_id: req_01JQ5W3H8M2N4P6R8T0V2X4Z6B
  schemas:
    Problem:
      type: object
      description: RFC 9457 problem details.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        code:
          type: string
          description: A code from the error catalog; new codes may be added.
          x-extensible-enum:
            - invalid_request
            - unknown_parameter
            - invalid_cursor
            - cursor_window_exceeded
            - invalid_reference
            - id_type_mismatch
            - invalid_keyword
            - shop_id_required
            - sales_window_not_covered
            - unauthorized
            - credits_exhausted
            - plan_required
            - insufficient_scope
            - workspace_required
            - workspace_locked
            - browser_refused
            - role_required
            - impersonation_refused
            - recent_sign_in_required
            - etsy_scope_required
            - etsy_partner_required
            - not_found
            - not_found_on_etsy
            - shop_opted_out
            - method_not_allowed
            - conflict
            - key_limit_reached
            - reconnect_required
            - listing_busy
            - shop_create_busy
            - idempotency_partial_unverifiable
            - activation_skipped
            - idempotency_processing
            - unprocessable
            - listing_removed_on_etsy
            - rate_limited
            - throttled
            - daily_credit_cap_exceeded
            - credits_reserved
            - fetch_limit_reached
            - shop_write_budget_exhausted
            - internal_error
            - write_misconfigured
            - upstream_unavailable
            - credits_unavailable
            - service_unavailable
            - fetch_unavailable
            - create_lock_unavailable
            - etsy_capacity
            - upstream_timeout
        detail:
          type: string
        suggestion:
          type: string
        retryable:
          type: boolean
        request_id:
          type: string
        upgrade_url:
          type: string
          format: uri
          description: 'credits_exhausted and plan_required: where to upgrade the plan.'
        credits_needed:
          type: integer
          description: 'API credit refusals: what the call needed.'
        credits_remaining:
          type: integer
          description: >-
            API credit refusals: what is left (of the month, or of the day for
            daily_credit_cap_exceeded).
        resets_at:
          type: string
          format: date-time
          description: >-
            credits_exhausted and daily_credit_cap_exceeded: when the limit
            resets.
      required:
        - type
        - title
        - status
        - code
        - detail
        - suggestion
        - retryable
        - request_id
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An API key: `Authorization: Bearer alura_sk_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.