---
title: "Retrieve options for a metaproperty"
url: "https://earlyaccess.developers.bynder.com/apis/metaproperty-options-1/versions/9b6f896a-c5dd-4f1a-a8e4-591e5ef4f1db/operations/getApi1TaxonomyMetapropertiesMetapropertyidOptions"
---

> Full API specification: https://earlyaccess.developers.bynder.com/apis/metaproperty-options-1/versions/9b6f896a-c5dd-4f1a-a8e4-591e5ef4f1db.md

# Retrieve options for a metaproperty

`GET` `/api/1/taxonomy/metaproperties/{metapropertyId}/options`

Operation ID: `getApi1TaxonomyMetapropertiesMetapropertyidOptions`

Retrieve options for a metaproperty.

## Path parameters

- `metapropertyId` (string, uuid, required)

## Query parameters

- `start` (string, optional)
- `before` (string, optional)
- `limit` (integer, int32, optional)
- `externalReference` (string, optional)
- `ids` (array, optional)

## Responses

- `200`
- `400`
- `404`

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Metaproperty options
  version: "1.0"
servers:
  - url: https://{your-bynder-domain}/
paths:
  /api/1/taxonomy/metaproperties/{metapropertyId}/options:
    get:
      description: Retrieve options for a metaproperty.
      operationId: getApi1TaxonomyMetapropertiesMetapropertyidOptions
      parameters:
        - in: path
          name: metapropertyId
          required: true
          schema:
            format: uuid
            type: string
        - in: query
          name: start
          required: false
          schema:
            type: string
        - in: query
          name: before
          required: false
          schema:
            type: string
        - in: query
          name: limit
          required: false
          schema:
            default: 20
            format: int32
            maximum: 1000
            minimum: 1
            type: integer
        - in: query
          name: externalReference
          required: false
          schema:
            default: ""
            type: string
        - in: query
          name: ids
          required: false
          schema:
            items:
              format: uuid
              type: string
            type: array
      responses:
        "200":
          content:
            application/json:
              examples:
                ListOptionsOutput:
                  summary: Response when listing options
                  value:
                    metadata: {}
                    options:
                      - externalReference: ext-ref-1
                        icon: ""
                        id: 00000000-0000-0000-0000-000000000001
                        name: Option 1
              schema:
                properties:
                  metadata:
                    properties:
                      nextPage:
                        type: string
                      prevPage:
                        type: string
                    title: MetadataOutput
                    type: object
                  options:
                    items:
                      properties:
                        definition:
                          type: string
                        externalReference:
                          type: string
                        icon:
                          type: string
                        id:
                          type: string
                        name:
                          type: string
                      required:
                        - id
                        - name
                        - externalReference
                        - icon
                      title: MetapropertyOption
                      type: object
                    type: array
                required:
                  - metadata
                title: ListOptionsOutput
                type: object
          description: ""
        "400":
          content:
            application/json:
              examples:
                OptionListCursorFormatInvalidOutput:
                  summary: Response when the cursor format for listing options is invalid.
                    Expected 'name_optionId'.
                  value:
                    errorCode: option-list-cursor-format-invalid
                    message: Invalid cursor format, expected 'name_optionId'
                OptionListCursorParameterInvalidOutput:
                  summary: Response when the cursor parameters for listing options are invalid.
                    'start' and 'before' cannot be used together.
                  value:
                    errorCode: option-list-cursor-parameter-invalid
                    message: Invalid parameters provided for listing options with cursor pagination,
                      'start' and 'before' cannot be used together
              schema:
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                title: OptionListInvalidOutput
                type: object
          description: ""
        "404":
          content:
            application/json:
              examples:
                MetapropertyNotExisting:
                  summary: Response when the metaproperty does not exist
                  value:
                    errorCode: metaproperty-not-existing
                    message: Metaproperty does not exist
              schema:
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                required:
                  - errorCode
                  - message
                title: MetapropertyNotExistingOutput
                type: object
          description: ""
      summary: Retrieve options for a metaproperty
      tags:
        - Options - New API (Preferred)
security:
  - OAuth2:
      - METAPROPERTYMANAGEMENT
      - METAMANAGEMENT
  - permanentToken:
      - METAPROPERTYMANAGEMENT
      - METAMANAGEMENT
components:
  securitySchemes:
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://{your-auth-url}
          scopes:
            METAMANAGEMENT: ""
            METAPROPERTYMANAGEMENT: ""
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
        clientCredentials:
          scopes:
            METAMANAGEMENT: ""
            METAPROPERTYMANAGEMENT: ""
          tokenUrl: https://{your-bynder-domain}/v6/authentication/oauth2/token
      type: oauth2
    permanentToken:
      in: header
      name: Authorization
      type: apiKey
```