ORora
project

Get project custom fields

get/projects/{project_id}/custom_fields

Request

  • Base URL
    https://api.ora.pm
  • Auth
    OAuth 2
    Authorization code: https://app.ora.pm/authorize
    Token URL: https://api.ora.pm/oauth/token scopes: read, write

Response

Success

uuidstring

UUID of the custom field.

creator_idinteger

Id of the user that created the custom field.

project_idinteger

Id of the project

namestring

Title of the custom field.

descriptionstring

Description about the custom field.

created_atstring date-time

Date and time when the custom field is created.

updated_atstring date-time

Date and time when the custom field is last updated.

positioninteger

0 - None, 1 - Left, 2 - Right (It's returned if the type is 2).

typeinteger

Type of the custom field (1 - Dropdown, 2 - Number, 3 - Text, 4 - Number, 5 - Date, 6 - Checkbox).

optionsobject[]

List with the dropdown options. (It's returned if the type is 1).

is_multilineboolean

True if the textfield is multiline. (It's returned if the type is 3).

number_formatinteger

1 - Number, 2 - USD, 3 - EUR, 4 - GBP, 5 - YEN, 6 - Percent, 7 - Custom, 8 - Unformatted (It's returned if the type is 3).

labelstring

Which label to show, Example: %, $. (It's returned if the type is 2).

decimalsinteger

(It's returned if the type is 2).

Example response

{
  "uuid": "ceca0749-7cea-4ddf-beb9-33ea0b043519",
  "creator_id": 1,
  "project_id": 10,
  "name": "Custom field name",
  "description": "Here you can tell something about the custom field.",
  "created_at": "2019-07-31T12:42:49.096305Z",
  "updated_at": "2019-07-31T12:42:49.096305Z",
  "position": 1,
  "type": 1,
  "options": [
    {
      "color": "#1B9AF7",
      "position": 0,
      "text": "Movie",
      "uuid": "8a28a100-70b0-4c27-9790-591f24549e0e"
    }
  ],
  "is_multiline": true,
  "number_format": 1,
  "label": "$",
  "decimals": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.