Dictionaries (pick lists)

A pick list is a set of values. One list can contain up to 200 values. List items can be set as values of job fields. Such fields are rendered as dropdowns or similar UI elements. This provides a better UX over typing values to text inputs.

Resource URL: https://api.planadoapp.com/v2/dictionaries

Listing dictionaries

$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/dictionaries | jq
{
  "dictionaries": [
    {
      "uuid": "da8a14c8-4df5-40d2-ad00-62f2da9e39e1",
      "name": "Week days"
    },
    {
      "uuid": "c2753f1a-b0cb-42e1-9e50-eeb0ef7e1eca",
      "name": "Damage type"
    }
  ]
}

Table 1. Fields of `dictionaries` elements
Field	Type	JSON Type	Can be `null`	Description
`uuid`	UUID	String	No	Unique identifier
`name`	String	String	No	Dictionary name. Must be unique, up to 200 characters

Listing dictionary values

$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/dictionaries/da8a14c8-4df5-40d2-ad00-62f2da9e39e1/values | jq
{
  "values": [
    {
      "uuid": "8f0e35bc-fc50-415a-9aa6-c7d797a01abf",
      "name": "Monday"
    },
    {
      "uuid": "b3ca8648-1ac3-4c6f-a57d-54b7473a1d10",
      "name": "Tuesday"
    },
    {
      "uuid": "36fe0cfd-193e-4e62-8731-286f8d1f2a89",
      "name": "Wednesday"
    },
    {
      "uuid": "dca5f25e-2970-43f8-8b2e-aa2bff1ecb9e",
      "name": "Thursday"
    },
    {
      "uuid": "47acd2a0-309b-480e-b1ad-4992e2e57d1b",
      "name": "Friday"
    },
    {
      "uuid": "0846669c-bc54-499e-9939-55d29b0e0ea7",
      "name": "Saturday"
    },
    {
      "uuid": "b5c02767-b7fb-4f70-8ab7-dadc1ee0f956",
      "name": "Sunday"
    }
  ]
}

Table 2. Fields of `values` elements
Field	Type	JSON Type	Can be `null`	Description
`uuid`	UUID	String	No	Unique identifier
`name`	String	String	No	Dictionary value. Must be unique, up to 200 characters