Skip to main content
GET
Error
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

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

Response

integer
Total number of matching lists.
string
URL for the next page, if one exists.
string
URL for the previous page, if one exists.
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