Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Custom Metadata

List properties

List all custom metadata properties for an account.

This endpoint is only available to accounts with advanced plans or above.

get/accounts/{account_id}/custom_metadata/properties

Path parameters

account_idstring required

Account ID

Query parameters

data_type'boolean' | 'date' | 'link' | 'multi_select' | 'number' | 'single_select' | 'string' | 'text'

data type of the property

Example:string

Data Type of Custom Metadata Property

project_idstring

id of project that the properties belong to

pageinteger

Page number

per_pageinteger

Limit on the number of objects to be returned, between 1 and 100. 25 by default

qstring

query to find a property by name

sortstring

Sort criteria. Can be one of: name, data_type, created_at.

orderstring

Order direction. Can be one of: asc, desc.

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Response

OK

idstring
namestring
descriptionstring
data_type'boolean' | 'date' | 'link' | 'multi_select' | 'number' | 'single_select' | 'string' | 'text'

data type of the property

value_optionsstring[]
created_atstring date-time
updated_atstring date-time

Example response

[
  {
    "id": "abcd1234cdef1234abcd1234cdef1234",
    "name": "Nuts",
    "description": "A healthy snack for all ages",
    "data_type": "multi_select",
    "user": {
      "id": "abcd1234cdef1234abcd1234cdef1234",
      "username": "joe.doe",
      "name": "Joe Doe"
    },
    "created_at": "2015-01-28T09:52:53Z",
    "updated_at": "2015-01-28T09:52:53Z",
    "projects": [
      {
        "id": "abcd1234cdef1234abcd1234cdef1234",
        "name": "My Android Project",
        "main_format": "xml",
        "created_at": "2015-01-28T09:52:53Z",
        "updated_at": "2015-01-28T09:52:53Z"
      }
    ],
    "value_options": [
      "apple",
      "banana",
      "coconut"
    ]
  }
]