Vistas

List Vistas Groups

Lists the available vista group items.

GET
/vistas.groups.list
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Query Parameters

ancestor_part?array<string>

Filters for vista group items which have one of the parts linked as its ancestor part or primary part.

applies_to_part.include_child_parts?boolean

Whether to include items belonging to children of any of the provided parts.

applies_to_part.parts?array<string>

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

created_by?array<string>

Filter for vistas group item created by any of these users.

cursor?string

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

Formattext
group_object_type?array<vista-group-item-group-object-type>

Filters for vista group items of the specific group object type.

limit?integer

The request to get information about a list of vista groups.

Formatint32
mode?string

The iteration mode to use, otherwise if not set, then "after" is used.

Value in"after" | "before"
parent_id?array<string>

Parent ID of the vista group item.

sort_by?array<string>

Comma-separated fields to sort the objects by.

state?array<vista-group-item-state>

Denotes the state of the vista group item.

type?array<group-item-type>

Filters for vista group items of the specific type.

Response Body

curl -X GET "https://api.devrev.ai/vistas.groups.list?ancestor_part=PROD-12345&applies_to_part.include_child_parts=true&applies_to_part.parts=PROD-12345&created_by=DEVU-12345&cursor=string&group_object_type=conversation&limit=0&mode=after&parent_id=VISTA-12345&sort_by=string&state=active&type=curated"
{
  "next_cursor": "string",
  "prev_cursor": "string",
  "vista_group": [
    {
      "object_type": "conversations",
      "end_date": "2023-01-01T12:00:00.000Z",
      "id": "string",
      "name": "string",
      "parent": {
        "type": "string",
        "display_id": "string",
        "flavor": "nnl",
        "id": "VISTA-12345",
        "name": "string"
      },
      "start_date": "2023-01-01T12:00:00.000Z",
      "state": "active",
      "type": "curated"
    }
  ]
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}