> ## 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 Instagram posts

> Retrieve a paginated list of Instagram posts.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const instagramPostList = await site.instagramPosts().listInstagramPosts()
```

```json 200 wrap theme={"dark"}
{
  "results": [
    {
      "title": "Example title",
      "caption": "Example caption",
      "mediaType": "image",
      "isReel": false,
      "featured": false,
      "slug": "example-slug",
      "visibility": "public",
      "scheduledPublish": "Example scheduled publish",
      "scheduledUnpublish": "Example scheduled unpublish",
      "_mediaImage": [
        {}
      ],
      "mediaUrl": "https://acme.example/example",
      "_video": [
        {}
      ],
      "videoUrl": "https://acme.example/example",
      "videoRehostStatus": "",
      "permalink": "https://acme.example/example",
      "postedAt": "2026-10-24",
      "likeCount": 0,
      "commentsCount": 0,
      "comments": [],
      "hiddenComments": [],
      "source": "manual",
      "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
      "archived": false,
      "videoRehostCapBytes": 0,
      "_id": "clx8m2k4p0000a1b2c3d4e5f6",
      "type": "Example type",
      "createdAt": "2026-10-24T09:30:00.000Z",
      "updatedAt": "2026-10-24T09:30:00.000Z",
      "aposShareKey": "k3v9x2m7q1z8w4p6"
    }
  ],
  "pages": 1,
  "currentPage": 1
}
```

## In your app

A controller answers a route on your app: it calls `listInstagramPosts()` and returns the answer.

**1. Add the controller**

```ts app/controllers/list_instagram_posts_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class ListInstagramPostsController {
  constructor(protected site: SiteClient) {}

  async handle() {
    return this.site.instagramPosts().listInstagramPosts()
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const ListInstagramPostsController = () => import('#controllers/list_instagram_posts_controller')

router.get('/instagram-post', [ListInstagramPostsController])
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:3333/instagram-post
```

With `node ace serve` running, it prints its answer as JSON.

> [accordion] Optional parameters
>
> One object, e.g. `listInstagramPosts({ page })`; leave out the optional fields.
>
> **page** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `1`. Page number for pagination (1-based)
>
> **perPage** `number | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Documents per page. Each content type has its own default (core’s is 50; a type may set another). There is no upper limit: a large value answers the whole list at once, which is slow on a big one. At least 1.
>
> **search** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Matches documents by their text. Ignored for the public and API keys on a type whose public fields leave some out (a search would match the hidden ones).
>
> **aposMode** `AposMode | null | undefined`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **renderAreas** `boolean | null | undefined`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.
>
> **slug** `string | null | undefined`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Only the document with exactly this slug: a list of one, or an empty list when none has it. Use it to find a document by the name in its URL.

> [accordion] Returns
>
> An `InstagramPostList`. A page of InstagramPost documents. Read its properties (`instagramPostList.results`): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (`_id` → `id`, `_mediaImage` → `mediaImage`, `_video` → `video`).
>
> **results** `readonly InstagramPost[]`
>
> **Always sent.** A list of `InstagramPost`. This page’s documents; empty past the last page.
>
> **InstagramPost**
>
> InstagramPost content type
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **id** `string`
>
> **Always sent.** The document’s id. On a type with drafts it ends in its locale and mode (`…:en:published`, `…:en:draft`): the part before the first colon is its `aposDocId`, shared by both copies. The `{_id}` the type’s routes take.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **caption** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The post caption. Shown (optionally truncated) under the image.
>
> **mediaType** `MediaType | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Drives the corner badge (a video/reel/album marker). One of `image`, `video`, `carousel`; a newer site may send others, so keep a fallback.
>
> **isReel** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Marks a video post as a reel (shows a reel badge instead of a generic video badge).
>
> **featured** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Hand-curation flag. The widget can be set to show only featured posts.
>
> **visibility** `Visibility | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **mediaImage** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The post image (a first-party media-library image). Used for manual posts and for synced posts when “re-host” storage is on. Falls back to the image URL below when empty. The related `@apostrophecms/image` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **mediaUrl** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A direct image URL (set by a sync in “hot-link” storage mode). Used only when no library image is set above. Instagram CDN URLs expire — prefer a library image. When set, a URL; empty or null when not.
>
> **video** `readonly Readonly\<Record\<string, unknown\>\>[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The playable clip as a first-party file (a piece from the Videos library). Set by a sync when “re-host” video storage is on; also pickable by hand for a manual post. Takes precedence over the video URL below — and, unlike it, never expires and needs no cookie consent to play. The related `video` documents, in order (empty when none). To set it, send a list of `{ "_id": "…" }`, one per document (one at most); a document the site can’t find is left out. At most 1 items.
>
> **videoUrl** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A direct, hot-linked video file URL (set by a sync for video/reel posts under “hot-link” video storage). Played in-place in the on-site lightbox; the still image above is the poster. Instagram CDN video URLs expire quickly (\~32h) — the site re-checks freshness and the cron keeps it rotating, and a visitor who has not accepted functional cookies gets the still instead (the file loads from Meta). Re-host the video to avoid both. When set, a URL; empty or null when not.
>
> **videoRehostStatus** `VideoRehostStatus | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Why this post’s clip is still loading from Instagram instead of your own media library. Anything other than the first value means the video expires in \~32h and is hidden from visitors who declined functional cookies. “Too large” is fixable: raise the cap in Connections → Instagram. One of \`\`, `too-large`, `not-video`, `failed`; a newer site may send others, so keep a fallback.
>
> **permalink** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The link to this post on Instagram. The whole tile links here when set. When set, a URL; empty or null when not.
>
> **postedAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Posted date. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **likeCount** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Likes.
>
> **commentsCount** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Comments count.
>
> **comments** `readonly InstagramPostCommentsItem[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A list of `InstagramPostCommentsItem`. Comments.
>
> **InstagramPostCommentsItem**
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **text** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Comment.
>
> **username** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Author.
>
> **fromId** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Author ID (IGSID).
>
> **parentId** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Parent comment ID.
>
> **timestamp** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Posted at.
>
> **likeCount** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Likes.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.
>
> **hiddenComments** `readonly InstagramPostHiddenCommentsItem[] | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. A list of `InstagramPostHiddenCommentsItem`. Hidden comments.
>
> **InstagramPostHiddenCommentsItem**
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **text** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Comment.
>
> **username** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Author.
>
> **fromId** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Author ID (IGSID).
>
> **parentId** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Parent comment ID.
>
> **timestamp** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Posted at.
>
> **likeCount** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Likes.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.
>
> **source** `InstagramPostSource | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Source. One of `manual`, `instagram-login`, `facebook-login`, `demo`; a newer site may send others, so keep a fallback.
>
> **sourceId** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The Graph media id — the de-duplication key set by a sync.
>
> **archived** `boolean | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **videoRehostCapBytes** `number | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. With `videoRehostStatus: too-large`, the size cap (bytes) the clip was over; 0 otherwise. Set by the sync.
>
> **createdAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `Date | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents.
>
> **pages** `number`
>
> **Always sent.** Pages in the whole list (0 when it is empty).
>
> **currentPage** `number`
>
> **Always sent.** This page, from 1.

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage` names it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No (only a 502, 503 or 504 is retried). **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `no answer`
>
> No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).
>
> **Retried first:** Yes, after 0.5 s then 1 s. **Read:** `reason`, `neverConnected`.
>
> **RequestNotSent** `not sent`
>
> The client refused to send it (e.g. a path segment of `..`); the site never saw it.
>
> **Retried first:** No. **Read:** `reason` (what to change).
>
> **SiteRequestFailed** `any other`
>
> Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).
>
> **Retried first:** No. **Read:** `reason`, `status`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (what to fix).

## Behavior

* **Access:** an API key with `content:instagram-posts:read` (or a master above it: `content:instagram-posts:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`) need `content:instagram-posts:write` (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
* **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **Retries:** a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
* **Timeout:** 15 s per attempt by default; raise `timeout` (milliseconds) in `config/attract.ts` for longer.
* **Paging:** one page per call. To walk them all, use `listInstagramPostsAll()` (see More examples): it asks for the next page as you iterate, and stops after page `pages`.

## More examples

`listInstagramPostsAll()` takes `listInstagramPosts()`’s arguments except `page`. `listInstagramPostsPick()` takes the same arguments except `page`, after the fields to answer: each row is the document’s `id` and those fields.

```ts Every page wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
for await (const instagramPost of site.instagramPosts().listInstagramPostsAll()) {
  console.log(instagramPost) // the next page is fetched as you iterate
}
```

```ts Only some fields wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const rows = await site.instagramPosts().listInstagramPostsPick(['title', 'slug']) // [{ id, title, slug }, …]: every Instagram post, across every page
```

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/instagram_posts_list_instagram_posts.spec.ts`, then run your tests:

```ts tests/unit/instagram_posts_list_instagram_posts.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import ListInstagramPostsController from '#controllers/list_instagram_posts_controller'

test('instagramPosts.listInstagramPosts', async () => {
  const site = fakeAttract()

  const controller = await app.container.make(ListInstagramPostsController)
  await controller.handle()

  site.assertCalled('instagramPosts.listInstagramPosts')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `instagramPosts.listInstagramPosts` with a `sequence()` of pages, each `factories.InstagramPostList({...})`, and walk `listInstagramPostsAll()`.

```ts tests/unit/instagram_posts_list_instagram_posts_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract, sequence } from '@fetchski/attract-cms-adonis/testing'

test('instagramPosts.listInstagramPosts answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'instagramPosts.listInstagramPosts': sequence(
      factories.InstagramPostList({ currentPage: 1, pages: 2 }),
      factories.InstagramPostList({ currentPage: 2, pages: 2 })
    ),
  })

  const walked: unknown[] = []
  for await (const instagramPost of site.instagramPosts().listInstagramPostsAll()) {
    walked.push(instagramPost)
  }
  assert.lengthOf(walked, 2)
})
```

To fake `listInstagramPostsAll()`, answer `instagramPosts.listInstagramPosts` (the walk calls it page by page): a `sequence()` of answers for several pages.

## Related

> [card] [List an Instagram post’s locales](https://docs.fetchski-attract.com/adonisjs/reference/instagram-posts/get-instagram-post-locales.md)
>
> `site.instagramPosts().getInstagramPostLocales()`

> [card] [Create an Instagram post](https://docs.fetchski-attract.com/adonisjs/reference/instagram-posts/create-instagram-post.md)
>
> `site.instagramPosts().createInstagramPost()`

> [card] [Get an Instagram post](https://docs.fetchski-attract.com/adonisjs/reference/instagram-posts/get-instagram-post.md)
>
> `site.instagramPosts().getInstagramPost()`

> [card] [Replace an Instagram post](https://docs.fetchski-attract.com/adonisjs/reference/instagram-posts/replace-instagram-post.md)
>
> `site.instagramPosts().replaceInstagramPost()`

> [card] [Delete an Instagram post](https://docs.fetchski-attract.com/adonisjs/reference/instagram-posts/delete-instagram-post.md)
>
> `site.instagramPosts().deleteInstagramPost()`

> [card] [Update an Instagram post](https://docs.fetchski-attract.com/adonisjs/reference/instagram-posts/update-instagram-post.md)
>
> `site.instagramPosts().updateInstagramPost()`

> [card] [GET /instagram-post](https://docs.fetchski-attract.com/api-reference/instagram-posts/list-instagram-posts.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.