v1
latestOpenAPI 3.0.12026-07-2471135326.0 KBLists
User Lists
This endpoint allows you to retrieve the information of the user's lists. Query parameters are supported. Extra filters can be added (e.g. name[like]=myFirstList).
get/v3/lists
Query parameters
limitinteger
Use limit operator to limit the number of records returned
skipinteger
Use skip operator to skip the specified number of records.
offsetstring
Use offset operator to search the next record to be consulted
Response
Successfully retrieved the user lists information
Example response
{
"meta": {
"timestamp": 1597166699457,
"transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
"explain": "a descriptive text"
},
"pagination": {
"offset": "e3293115e2ec5f466c67e047",
"limit": 6,
"next": "5f466c67e047e3293115e2ec",
"page": 1,
"pages": 10,
"total": 1000
},
"items": [
{
"id": 203,
"columns": [
{
"name": "mobile",
"type": "STRING",
"unique": true,
"indexed": true,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": -2,
"subType": "tel",
"visible": true,
"editable": false
}
},
{
"name": "email",
"type": "STRING",
"unique": true,
"indexed": true,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": -1,
"subType": "email",
"visible": true,
"editable": false
}
},
{
"name": "devices",
"type": "STRING",
"unique": false,
"indexed": true,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": "179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"subType": "array",
"visible": true,
"editable": false,
"internal": true
}
},
{
"name": "id",
"type": "STRING",
"unique": true,
"indexed": true,
"required": true,
"defaultValue": null,
"customConfiguration": null
},
{
"name": "devices_type",
"type": "STRING",
"unique": false,
"indexed": true,
"required": false,
"defaultValue": null,
"customConfiguration": null
},
{
"name": "full name",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "name",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "amigos",
"type": "NUMBER",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 7,
"subType": "number",
"visible": false,
"editable": true
}
},
{
"name": "friends",
"type": "NUMBER",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": "1",
"customConfiguration": {
"order": 8,
"subType": "number",
"visible": false,
"editable": true
}
},
{
"name": "gender",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "last name",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "test field",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 11,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "employee id",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "start date",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "birthday",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "supervisor id",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "middle",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "first name",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "address",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "government id",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "client",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "product",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "department",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "office",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "role",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "years",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "country",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "postal code",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "state",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "city",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
},
{
"name": "favorites",
"type": "STRING",
"unique": false,
"indexed": false,
"required": false,
"defaultValue": null,
"customConfiguration": {
"order": 0,
"subType": "text",
"visible": false,
"editable": true
}
}
],
"name": "test_list",
"userName": "Homer",
"size": 21,
"key": "id",
"autoId": true,
"usesGeneratedData": true,
"lastUpdated": "2020-08-08T19:43:36.278949Z",
"createdAt": "2020-08-08T19:43:36.278949Z",
"tags": [
"[yellow, blue, red]"
],
"status": "UPDATING",
"totalLines": 5,
"percentProcessed": 97
}
]
}