Vistas

List Vistas

Lists the available vistas.

GET
/vistas.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

created_by?array<string>

Filters for vistas created by any of these users.

cursor?string

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

Formattext
flavor?array<grouped-vista-flavor>

Filters for vistas of specific flavor.

is_default?boolean

Whether the default vistas should be fetched or not.

limit?integer

The maximum number of vistas to return. The default is '50', the maximum is '100'.

Formatint32
members?array<string>

Filters for vistas accessible to the input members.

mode?string

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

Value in"after" | "before"
object_type?array<dynamic-vista-filter-type>

Filters for vistas of specific object types like works, parts etc.

shared_with.member?string

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

Formatid
shared_with.role?string

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

Formatid
skip_items?boolean

Denotes whether to skip items of vista_group_item in response.

sort_by?array<string>

Fields to sort the vistas by and the direction to sort them.

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

Denotes the state of the vista group item.

type?array<vista-type>

Filters for vistas of the specific type.

Response Body

curl -X GET "https://api.devrev.ai/vistas.list?created_by=DEVU-12345&cursor=string&flavor=nnl&is_default=true&limit=0&members=DEVU-12345&mode=after&object_type=accounts&shared_with.member=string&shared_with.role=string&skip_items=true&sort_by=string&state=active&type=curated"
{
  "next_cursor": "string",
  "prev_cursor": "string",
  "vistas": [
    {
      "type": "curated",
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "is_default": true,
      "name": "string",
      "shared_with": [
        {
          "member": {
            "type": "dev_user",
            "display_id": "string",
            "id": "string",
            "display_name": "string",
            "display_picture": {
              "display_id": "string",
              "id": "string",
              "file": {
                "type": "string",
                "name": "string",
                "size": 0
              }
            },
            "email": "string",
            "full_name": "string",
            "state": "active"
          },
          "role": {
            "display_id": "string",
            "id": "string"
          }
        }
      ],
      "items": [
        {
          "type": "article",
          "display_id": "string",
          "id": "string",
          "article_type": "article",
          "resource": {
            "artifacts": [
              {
                "display_id": "string",
                "id": "string",
                "file": {
                  "type": "string",
                  "name": "string",
                  "size": 0
                }
              }
            ],
            "url": "string"
          },
          "title": "string"
        }
      ]
    }
  ]
}
{
  "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"
}