Pins

Read pin

Changed on

Read pin details given its ID.

post/rest/api/v1/getpin

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/rest/api/v1/getpin
  • Auth: HTTP bearer

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request body

idstring

The opaque id of the pin to be fetched.

Response

OK

Example response

{
  "pin": {
    "audienceFilters": [
      {
        "fieldName": "type",
        "values": [
          {
            "value": "Spreadsheet",
            "relationType": "EQUALS"
          },
          {
            "value": "Presentation",
            "relationType": "EQUALS"
          }
        ]
      }
    ],
    "attribution": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "updatedBy": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    }
  }
}

Changes

  • 31c4fd74a143Revision changes
    • warning

      added the new VIDEO_TYPE enum value to the /// response property for the response status

  • 2be6c492e9a6Revision changes
    • warning

      added the new SKILLS_TYPE enum value to the /// response property for the response status