API Reference

Retrieve a list of select lists

Description

Returns a list of select lists associated with the workspace.

GET /api/v1/selectlist

🚧

Required OAuth Scopes:

No OAuth scopes are required to use this endpoint.

Parameters

ParameterInTypeRequiredDescription
limitqueryinteger(int32)falseThe number of select lists to return, from 1 to 1000; by default, 1000
cursorquerystringfalseA paging cursor; if included, limit is ignored
offsetqueryinteger(int64)falseThe item to start with on the page, greater than or equal to 0; by default, 0

Code Samples

curl -X GET https://h.app.wdesk.com/s/wdata/prep/api/v1/selectlist  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://h.app.wdesk.com/s/wdata/prep/api/v1/selectlist  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://h.app.wdesk.com/s/wdata/prep/api/v1/selectlist" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://h.app.wdesk.com/s/wdata/prep/api/v1/selectlist', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with body and cursor properties.

  • body contains an array of SelectListDto objects. If the request returns no results, body contains an empty array.
  • cursor contains a paging cursor, which can be included in the next call to the endpoint to retrieve the next set of results. If there are no additional results, cursor is null.

Example Responses


{
  "body": [
    {
      "created": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "type": "string",
      "updated": "string",
      "userId": "string",
      "valueType": "string",
      "values": [
        {}
      ],
      "version": "integer"
    }
  ],
  "code": "integer",
  "cursor": "string"
}