Skip to main content
GET
Get one saved view or segment

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

view_id
integer
required
Required range: x >= 1

Response

200 - application/json

Successful Response

id
integer
required
name
string
required
object
enum<string>
required

The records the view selects: pass its id as view_id to this object's list

Available options:
account,
contact,
opportunity
shared
boolean
required

A workspace view, which every member sees

table
string
required

The app page (or page tab) the view belongs to, such as accounts or accounts_customer

type
enum<string>
required
Available options:
view,
segment
conditions
Conditions · object | null

The view's filter, in the app's own filter format; none selects every record

list_type
enum<string> | null

Whose records the view selects. my_book and team_book are the book of the key's creator; none means every record

Available options:
my_book,
team_book,
all_customers,
churned,
unset,
other
owner
ViewOwner · object | null