API ReferenceVistas

List Vistas Groups

Lists the available vista group items.

Headers

AuthorizationstringRequired

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

Query parameters

ancestor_partlist of stringsOptional
Filters for vista group items which have one of the parts linked as its ancestor part or primary part.
applies_to_part.include_child_partsbooleanOptional
Whether to include items belonging to children of any of the provided parts.
applies_to_part.partslist of stringsOptional

Part IDs to filter on. Required if any applies_to_part.* fields are provided.

created_bylist of stringsOptional
Filter for vistas group item created by any of these users.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
group_object_typelist of enumsOptional
Filters for vista group items of the specific group object type.
Allowed values:
limitintegerOptional
The request to get information about a list of vista groups.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
parent_idlist of stringsOptional
Parent ID of the vista group item.
sort_bylist of stringsOptional

Comma-separated fields to sort the objects by.

statelist of enumsOptional
Denotes the state of the vista group item.
Allowed values:
typelist of enumsOptional
Filters for vista group items of the specific type.
Allowed values:

Response

The response to listing the vistas group items.
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.
vista_grouplist of objects or null
List of vista group items.

Errors