Skip to main content
GET
/
accounts
/
{account_id}
/
custom_metadata
/
properties
cURL
curl "https://api.phrase.com/v2/accounts/:account_id/custom_metadata/properties?data_type=boolean&project_id=1&page=1&per_page=10&sort=created_at&order=desc" \
  -u USERNAME_OR_ACCESS_TOKEN
[
  {
    "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"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

​
X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

​
account_id
string
required

Account ID

Query Parameters

​
data_type
enum<string>

Data Type of Custom Metadata Property data type of the property

Available options:
boolean,
date,
link,
multi_select,
number,
single_select,
string,
text
Example:

"string"

​
project_id
string

id of project that the properties belong to

​
page
integer

Page number

​
per_page
integer

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

​
q
string

query to find a property by name

​
sort
string

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

​
order
string

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

Response

OK

​
id
string
​
name
string
​
description
string
​
data_type
enum<string>

data type of the property

Available options:
boolean,
date,
link,
multi_select,
number,
single_select,
string,
text
Example:

"string"

​
user
user_preview · object
Example:
{
  "id": "abcd1234cdef1234abcd1234cdef1234",
  "username": "johndoe",
  "name": "John Doe",
  "gravatar_uid": "205e460b479e2e5b48aec07710c08d50"
}
​
projects
project_short · object[]
​
value_options
string[]
​
created_at
string<date-time>
​
updated_at
string<date-time>