Vistas

List Vistas Groups (POST)

Lists the available vista group items.

POST
/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

type?array<group-item-type>

Filters for vista group items of the specific type.

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?applies-to-part-filter

The filter for applies to part.

created_by?array<string>

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

created_date?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295
cursor?string

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

Formattext
end_date?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295
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?list-mode

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.

Value in"after" | "before"
modified_date?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295
parent_id?array<string>

Parent ID of the vista group item.

sort_by?array<string>

Comma-separated fields to sort the objects by.

start_date?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295
state?array<vista-group-item-state>

Denotes the state of the vista group item.

Response Body

curl -X POST "https://api.devrev.ai/vistas.groups.list" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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"
}