v6

latestOpenAPI 3.1.0raw.githubusercontent.com2025-04-245712812.6 KB
Lists

List all lists

List all lists that your access token has access to. lists are returned in the order that they are sorted in the sidebar.

Required scopes: list_configuration:read.

get/v2/lists

Response

Success

Example response

{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
      },
      "api_slug": "hiring-engineering",
      "name": "Hiring Engineering",
      "parent_object": [
        "people"
      ],
      "workspace_access": "read-and-write",
      "workspace_member_access": [
        {
          "workspace_member_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "level": "read-and-write"
        }
      ],
      "created_by_actor": {
        "type": "workspace-member",
        "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
      },
      "created_at": "2022-11-21T13:22:49.061281000Z"
    }
  ]
}