{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/smartlist/:id/option","auth":"required","settings":"5e2b1ec0f26a2c00510363e5","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"page\": 1,\n  \"perPage\": 10,\n  \"query\": \"\",\n  \"results\": [\n    {\n      \"created\": \"2020-05-18 08:39:20-05:00\",\n      \"id\": 254,\n      \"imageUrl\": \"\",\n      \"label\": \"label 1\",\n      \"sort\": 1,\n      \"updated\": \"2020-05-18 08:39:20-05:00\",\n      \"value\": \"value 1\"\n    },\n    {\n      \"created\": \"2020-05-18 08:42:02-05:00\",\n      \"id\": 257,\n      \"imageUrl\": \"\",\n      \"label\": \"label 2\",\n      \"sort\": 2,\n      \"updated\": \"2020-05-18 08:42:02-05:00\",\n      \"value\": \"value 2\"\n    }\n  ],\n  \"total\": 2\n}\n","name":null},{"status":404,"language":"text","code":""}]},"examples":{"codes":[{"language":"text","code":""}]},"method":"get","params":[{"name":"query","type":"string","default":"","desc":"Optionally search Smart Lists Options by label","required":false,"in":"query","ref":"","_id":"5ec2b4f8f3a0c0020843488c"},{"name":"page","type":"int","default":"1","desc":"Optionally specific","required":false,"in":"query","ref":"","_id":"5ec2d5122b61ca003ba6b20b"},{"name":"perPage","type":"int","default":"10","desc":"","required":false,"in":"query","ref":"","_id":"5ec2d5122b61ca003ba6b20a"},{"name":"id","type":"int","default":"","desc":"Smart List ID","required":true,"in":"path","ref":"","_id":"5ed529878ffe94082e3363c7"}]},"next":{"description":"","pages":[]},"title":"/smartlist/:id/option","type":"endpoint","slug":"smartlist-option-get-all","excerpt":"Get the details of all Smart List options","body":"Get a paginated list of a Smart List's options with an optional label query filter.\n\nSee model definition: https://developers.formstack.com/v2.0/docs/smart-lists#section-smartlistoptionresults","updates":[],"order":79,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ec6d6303921cd00127c0e4a","createdAt":"2020-05-21T19:27:44.635Z","user":"58c99a66fa6c4b0f0031a912","category":{"sync":{"isSync":false,"url":""},"pages":["5435626c5ff8a51a006e4110","543553953513400800a14736","543555cc3513400800a14752","54355bcc35740020002a1b3b","5434928b0ef9c0080016520e","54347c8e5b10711400c6c30a","54346f750ef9c00800164fa0","543470f45b10711400c6c1e5","543477b70ef9c0080016505b","543478fb5b10711400c6c29f","54347d105b10711400c6c318","54347df00ef9c008001650d2","54347edf5b10711400c6c336","54357a175e1b2020004380dc","543483520ef9c0080016512a","543484820ef9c0080016513a","5434887e5b10711400c6c3cd","543488c05b10711400c6c3d2","54348ac85b10711400c6c401","5434959c0ef9c0080016522d","543497030ef9c00800165244","543498ae5b10711400c6c4f6","54349b7f0ef9c00800165293","54349c070ef9c00800165298","54349dbf0ef9c008001652ad","5434ab8e0ef9c00800165384","5434abbb0ef9c0080016538f","5434ac495b10711400c6c626","5434ada40ef9c008001653a8","5434af0a0ef9c008001653bc","5434af5f0ef9c008001653c8","5434b00a5b10711400c6c66b","5434b0d15b10711400c6c68c","5434b1ee0ef9c00800165406","5434b26d0ef9c0080016541c","5434b3560ef9c00800165427","5434b3b40ef9c0080016545a","5434b49f008ec22200d86ab9","5434b51f008ec22200d86aca","5434b5a80ef9c0080016546f","5434b5f4008ec22200d86ad8","5434b676008ec22200d86add","5434b6e6008ec22200d86ae5"],"title":"REST API","slug":"rest-api","order":1,"from_sync":false,"reference":false,"_id":"5434918d0ef9c008001651ff","version":"54346a2a0ef9c00800164f28","__v":30,"project":"543469460ef9c00800164f0e","createdAt":"2014-10-08T01:21:17.804Z"},"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510","5b6af3dffc81e4000383db74"],"_id":"54346a2a0ef9c00800164f28","releaseDate":"2014-10-07T22:33:14.982Z","createdAt":"2014-10-07T22:33:14.982Z","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":8},"project":"543469460ef9c00800164f0e","__v":7,"parentDoc":null}

get/smartlist/:id/option

Get the details of all Smart List options

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Smart List ID

Query Params

query:
string
Optionally search Smart Lists Options by label
page:
integer1
Optionally specific
perPage:
integer10

Result Format


Documentation

Get a paginated list of a Smart List's options with an optional label query filter. See model definition: https://developers.formstack.com/v2.0/docs/smart-lists#section-smartlistoptionresults

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}