> ## Documentation Index > Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt > Use this file to discover all available pages before exploring further. # List images > The images in the library, most recently updated first, a page at a time. Use an image’s slug to reference it in an MDX blog import. **Access:** an API key with `images:read` — or `media:all`, or `admin:all` — or any signed-in CMS user (who sees only what they may view). Anonymous callers get 403. ## OpenAPI ````yaml /api-reference/openapi.yaml get /fetchski-media/images openapi: 3.1.0 info: title: Fetchski Attract CMS API description: >- Auto-generated OpenAPI spec for this Fetchski site instance. Authenticate machine-to-machine requests with an API key by sending the header `Authorization: ApiKey `. Keys are issued in the CMS (API Keys) and carry scopes that limit them to specific actions. Each key also has its own security policy, chosen when it is created: a signing mode (token only, signed writes, or every request signed with the key’s signing secret via `X-Fetchski-Timestamp` + `X-Fetchski-Signature`), an optional network allowlist, and reads/writes-per-minute limits (429 with `Retry-After` over them). Some routes require a signature from every key — see each route. version: 1.0.0 servers: - url: https://{host}/api/v1 description: 'Your site: set `host` to its host name.' variables: host: default: acme.example security: [] tags: - name: Authentication description: >- Sign in as a person to get a bearer token or a session cookie. Integrations use an API key instead: send `Authorization: ApiKey `. - name: SDK Packages description: >- The site’s own npm registry and Composer repository for the Attract SDKs, so an app installs them with one of the site’s API keys. Point npm, pnpm, Bun or Composer at them; the SDKs never call them. - name: Pages description: 'The page tree: each page’s content, place and URL.' - name: Global Content description: Site-wide content and settings every page shares. - name: Redirects description: Old URLs and where they now send visitors. - name: Internationalization description: The site’s locales. - name: Languages description: >- The site’s languages: the main language’s name and every further language’s name, code and Public switch. A save applies at once: a new language gets its home page and its own addresses (/fr/…), and its pages are then translated with each type’s localize routes. - name: Page Templates description: >- The site’s whole-page starting arrangements. They are not pages of the site (the Pages list leaves them out for API keys): read one, then make a page from it with Pages → create and `_copyingId` (`copyingId` in the SDKs). - name: Blog Posts description: The blog’s posts, and importing them from Markdown or MDX. - name: Blog Categories description: The categories posts are filed under. - name: Authors description: The people posts are credited to. - name: Team Members description: The people the Team section shows. - name: Testimonials description: Quotes from customers. - name: FAQ Items description: Questions and their answers. - name: FAQ Categories description: The groups questions are sorted into. - name: Google Reviews description: Reviews from the business’s Google profile, synced on a schedule. - name: Instagram Posts description: Posts from the connected Instagram account, synced on a schedule. - name: Service Areas description: The places the business serves, for the service map. - name: Cookies description: The cookies the consent banner declares. - name: Media description: The Images and Files libraries, and their tags. - name: Videos description: The Videos library. - name: Image Folders description: The folders that organize the Images library. - name: File Folders description: The folders that organize the Files library. - name: Video Folders description: The folders that organize the Videos library. - name: Photo Albums description: Hand-picked, ordered sets of photos for galleries. - name: Photo Feeds description: >- Feeds that collect photos from a connected photo source into the Images library on a schedule. - name: Attachments description: Uploading files and cropping images. - name: Fetchski Media description: >- Read-only discovery over the Images and Videos libraries: find what to reference in an MDX blog import, or which file to use, with its URLs. - name: Forms description: The site’s forms and their fields. - name: Form Submissions description: >- What visitors sent through the site’s forms. Submissions hold personal details: give a key `forms:read` only where it is needed. - name: Conversion Events description: >- The conversion event log — one record per conversion, with its attribution and consent snapshot and its delivery to each ad platform. Read it incrementally, post facts from other systems (a reservation purchase, a lead outcome), and adjust them (refunds, cancellations). One event ID travels everywhere as the platforms’ de-duplication key. - name: Visitor Attribution description: >- Per-visitor attribution on this site: first touch, last ad or campaign touch, and the ad platforms’ browser IDs. The join other systems use to attach a purchase to the marketing-site journey that led to it. - name: Ads Metrics description: >- Aggregates for dashboards: ad-click landings and conversions, by day, platform, campaign and more. - name: Conversions description: >- Conversion definitions — the visitor actions (a lead, a call click, a booking, a purchase) this site reports to the ad platforms, each with a row per platform. Managed by administrators in the CMS. - name: Webhooks description: >- Push notifications of form submissions and conversion-event changes to the site’s Webhook Destinations — signed with each destination’s own secret, retried for a day, at-least-once. Set destinations up in the CMS (Webhook Destinations, for people granted “Manage webhook destinations”): URL, events, optional filters and custom headers, and the signing secret shown once. - name: Request Log description: >- The page views the site captured (Connections → Tracking → Request log), and the query parameters on them: campaign tags and ad click IDs. paths: /fetchski-media/images: get: tags: - Fetchski Media summary: List images description: >- The images in the library, most recently updated first, a page at a time. Use an image’s slug to reference it in an MDX blog import. **Access:** an API key with `images:read` — or `media:all`, or `admin:all` — or any signed-in CMS user (who sees only what they may view). Anonymous callers get 403. operationId: listMediaImages parameters: - name: q in: query required: false description: >- Words matched against each image’s title, alt text and other text: any of the words matches, best match first. schema: type: string - name: folder in: query required: false description: 'A media folder ID: only what is in that folder.' schema: type: string - name: includeSubfolders in: query required: false description: 'With `folder`: include its subfolders too.' schema: type: boolean default: true - name: limit in: query required: false description: >- Items per page: 1 to 100, 25 when left out (a value outside is brought into that range, never refused). schema: type: integer minimum: 1 maximum: 100 default: 25 - name: page in: query required: false description: Page number, from 1. schema: type: integer minimum: 1 default: 1 responses: '200': description: A page of images. content: application/json: schema: $ref: '#/components/schemas/ListMediaImagesResponse' example: results: - _id: clx8k2m0a0001abcd1234efgh slug: image-team-at-work title: Team at work alt: Three people around a table with laptops folderPath: Marketing/Team width: 2400 height: 1600 extension: jpg bytes: 845210 urls: original: >- https://cdn.example.com/attachments/abc123-team-at-work.original.jpg max: >- https://cdn.example.com/attachments/abc123-team-at-work.max.jpg full: >- https://cdn.example.com/attachments/abc123-team-at-work.full.jpg two-thirds: >- https://cdn.example.com/attachments/abc123-team-at-work.two-thirds.jpg one-half: >- https://cdn.example.com/attachments/abc123-team-at-work.one-half.jpg one-third: >- https://cdn.example.com/attachments/abc123-team-at-work.one-third.jpg one-sixth: >- https://cdn.example.com/attachments/abc123-team-at-work.one-sixth.jpg page: 1 perPage: 25 total: 1 '401': $ref: '#/components/responses/MediaUnauthorized' '403': $ref: '#/components/responses/MediaForbidden' '429': $ref: '#/components/responses/MediaRateLimited' security: - ApiKeyAuth: - images:read x-codeSamples: - lang: typescript label: TypeScript source: >- import { createSiteClient } from '@fetchski/attract-cms-sdk'; const site = createSiteClient(); const listMediaImages = await site.fetchskiMedia().listMediaImages(); - lang: php label: Laravel source: |- use Fetchski\AttractCmsLaravel\Facades\Attract; $listMediaImages = Attract::fetchskiMedia()->listMediaImages(); components: schemas: ListMediaImagesResponse: type: object required: - results - page - perPage - total properties: results: type: array items: $ref: '#/components/schemas/MediaImage' page: type: integer perPage: type: integer total: type: integer description: Every match, across all pages. MediaImage: type: object description: One image from the Images library. required: - _id - slug - title - alt - folderPath - width - height - extension - bytes - urls properties: _id: type: - string - 'null' description: The image’s document ID (aposDocId). slug: type: - string - 'null' description: Reference an image in an MDX import by it. title: type: - string - 'null' description: Its title. alt: type: string description: Alt text; empty when none is set. folderPath: type: - string - 'null' description: The media folder it sits in. width: type: - integer - 'null' description: Pixels. height: type: - integer - 'null' description: Pixels. extension: type: - string - 'null' description: File extension, e.g. `jpg`. bytes: type: - integer - 'null' description: Size of the original file. urls: type: object description: A URL per rendered size. properties: original: type: string format: uri max: type: string format: uri full: type: string format: uri two-thirds: type: string format: uri one-half: type: string format: uri one-third: type: string format: uri one-sixth: type: string format: uri example: _id: clx8k2m0a0001abcd1234efgh slug: image-team-at-work title: Team at work alt: Three people around a table with laptops folderPath: Marketing/Team width: 2400 height: 1600 extension: jpg bytes: 845210 urls: original: https://cdn.example.com/attachments/abc123-team-at-work.original.jpg max: https://cdn.example.com/attachments/abc123-team-at-work.max.jpg full: https://cdn.example.com/attachments/abc123-team-at-work.full.jpg two-thirds: >- https://cdn.example.com/attachments/abc123-team-at-work.two-thirds.jpg one-half: https://cdn.example.com/attachments/abc123-team-at-work.one-half.jpg one-third: >- https://cdn.example.com/attachments/abc123-team-at-work.one-third.jpg one-sixth: >- https://cdn.example.com/attachments/abc123-team-at-work.one-sixth.jpg MediaError: type: object required: - name - message properties: name: type: string description: The error kind, e.g. `notfound`. message: type: string data: type: object additionalProperties: true responses: MediaUnauthorized: description: >- The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not. content: application/json: schema: $ref: '#/components/schemas/MediaError' example: name: invalid message: The API key is not valid. data: {} MediaForbidden: description: >- The API key lacks the scope this route needs, is used from outside its allowlist, or the caller is anonymous. content: application/json: schema: $ref: '#/components/schemas/MediaError' example: name: forbidden message: 'This API key lacks the required scope: images:read.' data: {} MediaRateLimited: description: The key used up its reads-per-minute limit. Wait `Retry-After` seconds. content: application/json: schema: $ref: '#/components/schemas/MediaError' example: name: tooManyRequests message: This API key’s rate limit is used up for this minute. data: {} headers: Retry-After: description: Seconds until the budget resets. schema: type: integer minimum: 1 securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- Paste your API key as the CMS showed it: `fsk___` (issued under API Keys). `ApiKey ` in front of it works too. Leave it empty to read as the public. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.