API ReferenceVistas

List Vistas Groups (POST)

Lists the available vista group items.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
typelist of enumsOptional
Filters for vista group items of the specific type.
Allowed values:
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_partobjectOptional
The filter for applies to part.
created_bylist of stringsOptional
Filter for vistas group item created by any of these users.
created_dateobjectOptional
Provides ways to specify date ranges on objects.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
end_dateobjectOptional
Provides ways to specify date ranges on objects.
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. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

Allowed values:
modified_dateobjectOptional
Provides ways to specify date ranges on objects.
parent_idlist of stringsOptional
Parent ID of the vista group item.
sort_bylist of stringsOptional

Comma-separated fields to sort the objects by.

start_dateobjectOptional
Provides ways to specify date ranges on objects.
statelist of enumsOptional
Denotes the state of the vista group item.
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