Read (GET) All Items in a List
Use this API to read all items from a list by providing a code table value.
To read a list:
Execute a GET command on the endpoint
{{url}}/codeTable/<codetable>, where the
codetable variable is replaced by the name of the list you want to read.
For example, here is a request, using cURL, to get the list when the codetable variable is set to CFGEmployeeTitle. For a list of code table values, see GUID-9B82635D-5ED2-41EA-8FA1-C2882CFC3561.
curl --request GET \ --url 'https://{{url}}/codeTable/CFGEmployeeTitle' \ --header 'authorization: Bearer {{oauth_token}}' \ --header 'content-type: application/json'
The call returns the JSON representation of the list, for example:
[ { "Code": "Administra", "Description": "Administrative Assistant", "Seq": 1 }, { "Code": "Architect", "Description": "Architect", "Seq": 2 }, { "Code": "CADDOperat", "Description": "CADD Operator", "Seq": 3 }, { "Code": "CivilEngin", "Description": "Civil Engineer", "Seq": 4 }, { "Code": "ComputerSp", "Description": "Computer Specialist", "Seq": 5 }, { "Code": "Electrical", "Description": "Electrical Engineer", "Seq": 6 }, { "Code": "Environmen", "Description": "Environmental Engineer", "Seq": 7 }, { "Code": "InteriorDe", "Description": "Interior Designer", "Seq": 8 }, { "Code": "LandscapeA", "Description": "Landscape Architect", "Seq": 9 }, { "Code": "Mechanical", "Description": "Mechanical Engineer", "Seq": 10 }, { "Code": "Planner", "Description": "Planner", "Seq": 11 }, { "Code": "Principal", "Description": "Principal", "Seq": 12 }, { "Code": "ProjectMan", "Description": "Project Manager", "Seq": 13 }, { "Code": "Structural", "Description": "Structural Engineer", "Seq": 14 }, { "Code": "Surveyor", "Description": "Surveyor", "Seq": 15 }, { "Code": "Transporta", "Description": "Transportation Engineer", "Seq": 16 }, { "Code": "WetlandSpe", "Description": "Wetland Specialist", "Seq": 17 } ]