Retrieves a list of activity images from public storage blob with optional pagination.

GET /api/images/activities

Success: 200 OK

Products: Operator (FOH)
Features: Front of House Generic Access (FOHGENERIC)

Overview

Lists the activity images your tenant has uploaded to public image storage, each with the URL that serves it. Use it to let a user pick an existing image rather than uploading a new one, or to resolve the image referenced by an activity.

Images are kept per tenant, so you only ever see your own. The URLs are ordinary public URLs with no signature or expiry, so they can be embedded directly in a page and cached.

Pagination is opt-in. Omit pageSize and you get the entire set in one response — the usual case, since a tenant's image library is small — but that whole-set response can be briefly out of date, so an image uploaded through another route may take a moment to appear. Supply pageSize and you get one page plus a continuationToken to fetch the next; paged responses are always current.

To fetch a single image you already know the name of, use Retrieve an activity image by file name instead.

Endpoint

GET {base_url}/api/images/activities

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Query parameters

Name	Type	Required	Description
`pageSize`	integer (int32)	No	Maximum images per page. Omit it to receive every image in one response, which is the default behaviour and the only form that can be briefly out of date. Must be at least 1 when supplied — `0` or a negative value fails with `400` and `pageSize must be at least 1`. Supplying it always returns current data, so use it when you need a guaranteed-fresh read as well as when the library is large.
`continuationToken`	string	No	Take this verbatim from `continuationToken` in the previous response to fetch the next page; omit it for the first page. It is ignored unless you also send `pageSize`, so a request with a token but no page size silently returns everything from the start rather than the page you expected. The token is issued by the underlying storage, not by Gladstone — do not parse or construct it.

Sample request

cURL

curl -X GET '{base_url}/api/images/activities' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Response fields

Field	Type	Description
`pageSize`	integer (int32)	Echoes the `pageSize` you sent, or `null` when you sent none and therefore received the complete set. It is the reliable way to tell which of the two modes the response is in.
`continuationToken`	string	The token to pass to the next request, or `null` when there are no further pages — which is also always the case when you sent no `pageSize`. A `null` here is the only end-of-sequence signal; do not infer the end from a short page.
`images`	array of object	The images in this page, or all of them when no `pageSize` was sent. Empty rather than `null` when the tenant has uploaded none.
`images[].url`	string	The full public URL of the image, ready to use in an `img` tag. It carries no access token and does not expire, so it can be stored and shared. The path includes your tenant identifier.
`images[].fileName`	string	The file name including its extension, without any folder path. Names are stored lower-cased at upload, so expect lower case here, and this is the exact value to pass to Retrieve an activity image by file name.

Sample response

200 OK

{
  "pageSize": 1,
  "continuationToken": "string",
  "images": [
    {
      "url": "string",
      "fileName": "string"
    }
  ]
}

Errors

Status	Meaning	When
`400`	Bad request	`pageSize` was supplied as `0` or less. The body is the plain string `pageSize must be at least 1`. A malformed `continuationToken` does not produce a `400` here — it surfaces as a `500`.
`500`	Internal server error	Any unexpected server-side failure, including an invalid or expired `continuationToken`. The body is empty.

This page as markdown · All pages · llms.txt