---
title: "Get Content Library"
method: GET
path: "/v1/content-library"
tags: ["Content Library"]
---

# Get Content Library

`GET /v1/content-library`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/content-library`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/content-library/get.ts> (a function with typed inputs; its response is checked against the schema)

Fetch metadata for Content Library entries from your PX Subscription. The API provides you with the summary of basic information of each content item that makes it easy to work with specific data.

Results are sorted by last modified date descending by default.

Examples: 

| URI   | Results  |
| ----- | -------- |
| GET /v1/content-library?pageSize=100 | Get first 100 content library entries sorted by last modified date (desc). |
| GET /v1/content-library?pageSize=100&pageNumber=1 | Get next 100 content library entries. |
| GET /v1/content-library?productId=1234LPSWUBFW | Get content library entries of product 1234LPSWUBFW. |
| GET /v1/content-library?contentId=abcd1234 | Get a specific content entry by content ID. |
| GET /v1/content-library?excludeContentIds=abcd1234&excludeContentIds=efgh5678 | Get all content entries except those with the given content IDs. |
| GET /v1/content-library?sortColumnName=createdDate&sortOrder=ASC | Sort by created date ascending. |

<b>Important:</b> The default pageSize on list calls is 200. The pageSize can be changed by adding a pageSize parameter to the URL (i.e. /v1/content-library?pageSize=100) with a max pageSize=500. 

To fetch a particular page, use the pageNumber parameter (zero based)

## Query parameters

- `contentId` string
- `contentType` 'ENGAGEMENT' | 'GUIDE' | 'SLIDER' | 'DIALOG' | 'SURVEY' | 'ARTICLE' | 'LINKED_ARTICLE' | 'LINK' | 'FUNC_CALL'
- `excludeContentIds` string[]
- `pageNumber` integer
- `pageSize` integer
- `productId` string
- `searchTerms` string
- `sortColumnName` string[]
- `sortOrder` string

## Response `200`

Success

- KCContentExternalListViewPage
  - `content` KCContentExternalListViewDto[]
    - `additionalInfo` string
    - `articleProvider` 'ARTICLE_PROVIDER_UNDEFINED' | 'ZENDESK_ARTICLE_PROVIDER' | 'HELP_DOCS_ARTICLE_PROVIDER' | 'SALESFORCE_ARTICLE_PROVIDER' | 'MINDTOUCH_ARTICLE_PROVIDER' | 'BLOOMFIRE_ARTICLE_PROVIDER' | 'TI_ARTICLE_PROVIDER' | 'GOOGLE_SEARCH_PROVIDER' | 'HIGHER_LOGIC_PROVIDER' | 'CONTENTFUL_PROVIDER' | 'COVEO_PROVIDER' | 'ZOOM_IN_PROVIDER' | 'UNRECOGNIZED'
    - `contentId` string
    - `contentType` 'GUIDE' | 'ANNOUNCEMENT' | 'SLIDER' | 'LINK' | 'BOOLEAN_SURVEY' | 'RATING_SURVEY' | 'NPS_SURVEY' | 'CES_SURVEY' | 'MULTIPLE_QUESTION_SURVEY' | 'ARTICLE' | 'KNOWLEDGE_BASE_ARTICLE' | 'CUSTOM_LINK' | 'FUNC_CALL' | 'COMMUNITY'
    - `createdBy` UserView
      - `id` string
      - `name` string
    - `createdDate` integer
    - `description` string
    - `displayName` string
    - `id` string
    - `imageUrl` string
    - `lastModifiedBy` UserView
      - `id` string
      - `name` string
    - `lastModifiedDate` integer
    - `name` string
  - `first` boolean
  - `last` boolean
  - `number` integer
  - `numberOfElements` integer
  - `size` integer
  - `sort` SortPageDto[]
    - `direction` string
    - `property` string
  - `totalElements` integer
  - `totalPages` integer

## Other responses

- `400`: Bad request
- `401`: Unauthorized or bad API Key
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api.md) - [All operations](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/revisions/e7b197b373d8?raw)