Gallery

Reference for the gallery endpoints of the Interact REST API.

Note: All endpoints require authentication and an X-Tenant header. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.

Endpoints on this page

GET /api/gallery/{galleryId}/gallery-image

GET /api/gallery/{galleryId}/gallery-image

Get all gallery images by gallery id.

Parameters

Name	In	Type	Required
`galleryId`	path	integer (int32)	Yes
`offset`	query	integer (int32)	No
`limit`	query	integer (int32)	No
`order`	query	string	No

Responses

Status	Body
200	See below
400
403

Response body

{
  "Title": "string",
  "Context": [
    {
      "Images": [
        {
          "GalleryId": 0,
          "GalleryImageId": 0,
          "CreatedOn": "2024-01-01T00:00:00Z",
          "Title": "string",
          "Description": "string",
          "FileName": "string",
          "Height": 0,
          "Width": 0
        }
      ],
      "TotalResults": 0,
      "Offset": 0,
      "Limit": 0,
      "Order": "string",
      "StatusCode": "Continue"
    }
  ],
  "Description": "string",
  "StatusCode": "Continue",
  "ErrorCollection": {},
  "HasErrors": true,
  "TotalResults": 0
}

Field	Type
`Title`	string
`Context`	array of object
`Description`	string
`StatusCode`	string
`ErrorCollection`	object
`HasErrors`	boolean
`TotalResults`	integer (int32)

Section: REST API