Get a single lookuplist

GET /lookuplist/{id}

Get one lookup list along with the list of items within that list The structure of Team Skills is different because it is a multi-level layout

Path parameters

id integer Required

The ID of the lookup list to retrieve

Responses

200 application/json

OK For All lists except Team Skills, see response 201 for team skill output (although actual response will be 200)
Hide response attributes Show response attributes object
- id integer
- name string
- usage string
  
  Whether this lookup list has a special usage in infoodle Will be blank if no special purpose, otherwise one of:
  
  ADDRESSTYPES
  
  ATTENDANCE
  
  GROUPFREQUENCY
  
  GROUPFUNCTION
  
  GROUPSTATUS
  
  GROUPSUBURB
  
  MARITALSTATUS
  
  SCHOOLYEAR
  
  VHTASK
201 application/json

OK for team skills. The response code will still be 200, just to make the documentation clearer, hopefully.
Hide response attributes Show response attributes object
- id integer
- name string
- usage string
  
  Will be empty for Team Skills
- items array[object]
  
  List of categories for team skills
  
  Hide items attributes Show items attributes object
  
  category string
  
  The category name
  
  items array[object]
  
  List of items in this category
  
  Hide items attributes Show items attributes object
  
  id integer
  
  ID to be used when populating other end points
  
  value string
  
  Specific item within the category

GET /lookuplist/{id}

curl \
 -X GET https://YOURSITE.infoodle.com/apiv2/lookuplist/45 \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": 234,
  "name": "School year",
  "usage": "ADDRESSTYPES"
}

Response examples (201)

{
  "id": 234,
  "name": "School year",
  "usage": "string",
  "items": [
    {
      "category": "Musical Instruments",
      "items": [
        {
          "id": 562,
          "value": "Guitar"
        }
      ]
    }
  ]
}