Skip to main content
GET
/
lists
List lists
curl --request GET \
  --url https://api.gospott.com/lists \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "colorHex": "<string>",
      "createdBy": {
        "id": "<string>",
        "name": "<string>",
        "avatarUrl": "<string>",
        "deactivatedAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "cursor": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Query Parameters

​
limit
integer
default:25

Number of lists to return per page (min: 1, max: 50, default: 25).

Required range: 1 <= x <= 50
Example:

25

​
cursor
string

Base64-encoded cursor for pagination. Use the cursor value from a previous response to fetch the next page. Omit for the first page.

​
type
enum<string>

Filter lists by visibility type.

Available options:
PERSONAL,
WORKSPACE
Example:

"WORKSPACE"

Response

Successfully retrieved lists.

​
items
object[]
required
​
pagination
object
required