API ReferenceVistas

List Vistas

Lists the available vistas.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

created_bylist of stringsOptional
Filters for vistas created by any of these users.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
flavorlist of enumsOptional
Filters for vistas of specific flavor.
Allowed values:
is_defaultbooleanOptional
Whether the default vistas should be fetched or not.
limitintegerOptional
The maximum number of vistas to return. The default is '50', the maximum is '100'.
memberslist of stringsOptional
Filters for vistas accessible to the input members.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
object_typelist of enumsOptional
Filters for vistas of specific object types like works, parts etc.
shared_with.memberstringOptionalformat: "id"

ID of the group/member with whom the item is shared.

shared_with.rolestringOptionalformat: "id"

Role ID of the group/member with whom the item is shared.

skip_itemsbooleanOptional

Denotes whether to skip items of vista_group_item in response.

sort_bylist of stringsOptional
Fields to sort the vistas by and the direction to sort them.
statelist of enumsOptional
Denotes the state of the vista group item.
Allowed values:
typelist of enumsOptional
Filters for vistas of the specific type.
Allowed values:

Response

The response to listing the vistas.
vistaslist of objects
The list of vistas.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors