/api/v1/saved-views (GET)

GET

/api/v1/saved-views

const url = 'https://example.com/api/v1/saved-views?surface=search&limit=100';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/saved-views?surface=search&limit=100'

Parameters

Query Parameters

surface

string

Allowed values: search activity trash things contents inbox schedules lending paperwork expiring notifications incidents ai-calls services vehicles fuel readings condition-reports moves move-boxes

limit

integer

default: 100 >= 1 <= 100

cursor

string

<= 2048 characters

Responses

200

Default Response

application/json

object

views

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

surface

required

string

Allowed values: search activity trash things contents inbox schedules lending paperwork expiring notifications incidents ai-calls services vehicles fuel readings condition-reports moves move-boxes

query

required

object

string

filters

object

key

additional properties

Array<string>

not

Array<string>

group

string

sort

string

dir

string

Allowed values: asc desc

layout

string

sharedLocationId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

createdBy

required

object

displayName

required

string

mine

required

boolean

rowVersion

required

integer

>= -9007199254740991 <= 9007199254740991

moneyHidden

boolean

next_cursor

required

string | null

prefs

required

Any of:

object
null

object

defaultViewId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

pinned

required

Array<string>

Example

{
  "views": [
    {
      "surface": "search",
      "query": {
        "dir": "asc"
      },
      "moneyHidden": true
    }
  ]
}