curl --request POST \
  --url https://{domain}-be.glean.com/rest/api/v1/listshortcuts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "includeFields": [
    "FACETS"
  ],
  "pageSize": 10,
  "cursor": "<string>",
  "filters": [
    {
      "fieldName": "type",
      "values": [
        {
          "value": "Spreadsheet",
          "relationType": "EQUALS"
        },
        {
          "value": "Presentation",
          "relationType": "EQUALS"
        }
      ]
    }
  ],
  "sort": {
    "orderBy": "ASC",
    "sortBy": "<string>"
  },
  "query": "<string>"
}'
{
  "shortcuts": [
    {
      "id": 123,
      "inputAlias": "<string>",
      "destinationUrl": "<string>",
      "destinationDocumentId": "<string>",
      "description": "<string>",
      "unlisted": true,
      "urlTemplate": "<string>",
      "addedRoles": [
        {
          "sourceDocumentSpec": {
            "url": "<string>"
          },
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "group": {
            "type": "DEPARTMENT",
            "id": "<string>",
            "name": "<string>"
          },
          "role": "OWNER"
        }
      ],
      "removedRoles": [
        {
          "sourceDocumentSpec": {
            "url": "<string>"
          },
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "group": {
            "type": "DEPARTMENT",
            "id": "<string>",
            "name": "<string>"
          },
          "role": "OWNER"
        }
      ],
      "permissions": {
        "write": {
          "scopeType": "GLOBAL",
          "create": true,
          "update": true,
          "delete": true
        }
      },
      "createdBy": {
        "name": "George Clooney",
        "obfuscatedId": "abc123"
      },
      "createTime": "2023-11-07T05:31:56Z",
      "updatedBy": {
        "name": "George Clooney",
        "obfuscatedId": "abc123"
      },
      "updateTime": "2023-11-07T05:31:56Z",
      "destinationDocument": {
        "id": "<string>",
        "datasource": "<string>",
        "connectorType": "API_CRAWL",
        "docType": "<string>",
        "content": {
          "fullTextList": [
            "<string>"
          ]
        },
        "containerDocument": {},
        "parentDocument": {},
        "title": "<string>",
        "url": "<string>",
        "metadata": {
          "container": "container",
          "parentId": "JIRA_EN-1337",
          "createTime": "2000-01-23T04:56:07.000Z",
          "datasource": "datasource",
          "author": {
            "name": "name"
          },
          "documentId": "documentId",
          "updateTime": "2000-01-23T04:56:07.000Z",
          "mimeType": "mimeType",
          "objectType": "Feature Request",
          "components": [
            "Backend",
            "Networking"
          ],
          "status": [
            "Done"
          ],
          "customData": {
            "someCustomField": "someCustomValue"
          }
        },
        "sections": [
          {
            "title": "<string>",
            "url": "<string>"
          }
        ]
      },
      "intermediateUrl": "<string>",
      "viewPrefix": "<string>",
      "isExternal": true,
      "editUrl": "<string>",
      "alias": "<string>",
      "title": "<string>",
      "roles": [
        {
          "sourceDocumentSpec": {
            "url": "<string>"
          },
          "person": {
            "name": "George Clooney",
            "obfuscatedId": "abc123"
          },
          "group": {
            "type": "DEPARTMENT",
            "id": "<string>",
            "name": "<string>"
          },
          "role": "OWNER"
        }
      ]
    }
  ],
  "facetResults": [
    {
      "sourceName": "container_name",
      "operatorName": "SelectMultiple",
      "buckets": [
        {
          "count": 1,
          "datasource": "jira",
          "percentage": 5,
          "value": {
            "stringValue": "engineering",
            "integerValue": 5,
            "displayLabel": "engineering",
            "iconConfig": {
              "color": "#343CED",
              "key": "person_icon",
              "iconType": "GLYPH",
              "name": "user"
            }
          }
        }
      ],
      "hasMoreBuckets": false,
      "groupName": "Service Cloud"
    }
  ],
  "meta": {
    "cursor": "<string>",
    "hasNextPage": true,
    "totalItemCount": 123
  }
}

Authorizations

Authorization
string
header
required

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

Headers

X-Scio-Actas
string

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

X-Glean-Auth-Type
string

Auth type being used to access the endpoint (should be non-empty only for global tokens).

Body

application/json
Filters, sorters, paging params required for pagination
pageSize
integer
required
Example:

10

includeFields
enum<string>[]

Array of fields/data to be included in response that are not included by default

Available options:
FACETS,
PEOPLE_DETAILS
cursor
string

A token specifying the position in the overall results to start at. Received from the endpoint and iterated back. Currently being used as page no (as we implement offset pagination)

filters
object[]

A list of filters for the query. An AND is assumed between different filters. We support filters on Go Link name, author, department and type.

sort
object

Specifies fieldname to sort on and order (ASC|DESC) to sort in

query
string

Search query that should be a substring in atleast one of the fields (alias , inputAlias, destinationUrl, description). Empty query does not filter shortcuts.

Response

200
application/json
OK
shortcuts
object[]
required

List of all shortcuts accessible to the user

meta
object
required

Contains metadata like total item count and whether next page exists

facetResults
object[]