List pins

post/listpins

Lists all pins.

SecurityBearerAuth
Request
header Parameters
X-Glean-Auth-Type
string

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

X-Scio-Actas
string <email>

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

Request Body schema: application/json
required

List pins request

object
Responses
200

OK

Response Schema: application/json
required
Array of objects (PinDocument)

List of pinned documents.

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples
application/json
{ }
Response samples
application/json
{
  • "pins": [
    • {
      • "queries": [
        • "string"
        ],
      • "audienceFilters": [
        • {
          • "fieldName": "type",
          • "values": [
            • {
              • "value": "Spreadsheet",
              • "relationType": "EQUALS"
              },
            • {
              • "value": "Presentation",
              • "relationType": "EQUALS"
              }
            ]
          }
        ],
      • "id": "string",
      • "documentId": "string",
      • "attribution": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "updatedBy": {
        • "name": "George Clooney",
        • "obfuscatedId": "abc123"
        },
      • "createTime": "2019-08-24T14:15:22Z",
      • "updateTime": "2019-08-24T14:15:22Z"
      }
    ]
}