logo

Retrieve latest list version

Retrieves the latest version of a list with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

List retrieved.

Response Schema: application/json
description
required
string

Description of the list.

values
required
Array of strings

Values in the list.

id
string <= 50 characters

ID of the list.

version
integer >= 1

Version of the list.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/lists/{id}
Request samples 
// get the latest version
const lastest = await api.lists.get({id: 'foobar-001'});

// get an older version
const older = await api.lists.get({id: 'foobar-001', version: 12});
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "version": 1,
  • "description": "string",
  • "values": [
    ],
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Upsert a list