Skip to main content
GET
{baseUrl}
/
api
/
lists
/
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123
}
Returns saved lists the key creator can access. Use this endpoint before reading list rows, fields, views, or linked automation data.
Required API key scope: lists:read.

​
Query parameters

​
team_id
string
Team UUID. Required for team-scoped keys and useful when you want to list one team’s data.
​
ordering
string
Sort expression. Supported fields include created_at, updated_at, name, field_count, and row_count. Prefix with - for descending order.
​
page
integer
Page number for paginated responses.
​
page_size
integer
Number of lists per page.

​
Response

​
count
integer
Total number of matching lists.
​
next
string
URL for the next page, if one exists.
​
previous
string
URL for the previous page, if one exists.
​
results
array
List records visible to the key.

Authorizations

​
Authorization
string
header
default:phk_your_api_key
required

Paste your Pharen API key without the Bearer prefix.

Query Parameters

​
team_id
string<uuid>

Team UUID for team-scoped keys.

​
page
integer
default:1

Page number for paginated results.

Required range: x >= 1
​
per_page
integer
default:20

Number of results per page.

Required range: 1 <= x <= 100

Response

Lists returned.

​
data
object[]
​
total
integer
​
page
integer
​
per_page
integer