Clarify API
API ReferenceLists Object

Get Lists

GET
/workspaces/{workspace}/objects/{object}/lists
Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string
object*string

Query Parameters

page?
sortOrder?
filter?
search?string

Response Body

application/json

curl -X GET "https://example.com/workspaces/string/objects/string/lists"
{
  "links": {
    "next": "string",
    "prev": "string"
  },
  "meta": {
    "total_records": 0,
    "total_pages": 0
  },
  "data": [
    {
      "type": "list",
      "id": "string",
      "attributes": {
        "_id": "string",
        "user_id": "string",
        "entity": "string",
        "title": "string",
        "emoji": "string",
        "description": "string",
        "type": "dynamic",
        "state": "draft",
        "layout": "table",
        "options": {},
        "query": {
          "sql": "SELECT * FROM person"
        },
        "permission": "private",
        "rank": 0,
        "applied_version_id": null,
        "list_evaluation_status": "idle",
        "list_evaluation_started_at": "2019-08-24T14:15:22Z",
        "last_list_evaluation_at": "2019-08-24T14:15:22Z",
        "_updated_at": "2019-08-24T14:15:22Z",
        "_updated_by": "string",
        "_created_at": "2019-08-24T14:15:22Z",
        "_created_by": "string"
      },
      "relationships": {}
    }
  ]
}