> For the complete documentation index, see [llms.txt](https://developer.firmhouse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.firmhouse.com/sdks/firmhouse-sdk/reference/typealiases/paginated-response.md).

# Type Alias: PaginatedResponse

```ts
type PaginatedResponse<T> = {
  pageInfo?: {
     endCursor: string | null;
     hasNextPage: boolean;
     hasPreviousPage: boolean;
     startCursor: string | null;
  };
  results: T[];
  total: number;
};
```

Paginated Response

## Type Parameters

### T

`T`

## Properties

| Property                   | Type                                                                                                                            | Description                                        |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `pageInfo?`                | { `endCursor`: `string` \| `null`; `hasNextPage`: `boolean`; `hasPreviousPage`: `boolean`; `startCursor`: `string` \| `null`; } | -                                                  |
| `pageInfo.endCursor`       | `string` \| `null`                                                                                                              | When paginating forwards, the cursor to continue.  |
| `pageInfo.hasNextPage`     | `boolean`                                                                                                                       | When paginating forwards, are there more items?    |
| `pageInfo.hasPreviousPage` | `boolean`                                                                                                                       | When paginating backwards, are there more items?   |
| `pageInfo.startCursor`     | `string` \| `null`                                                                                                              | When paginating backwards, the cursor to continue. |
| `results`                  | `T`\[]                                                                                                                          | A list of nodes.                                   |
| `total`                    | `number`                                                                                                                        | The total amount of items available.               |