Get All Books

get https://api.betatest.degreed.com/api/v2/content/books

This endpoint retrieves all books for the current organization.

For Global Admin Tool Organizations, if the X-Degreed-Organization-Code header is included, the endpoint will return content for the Tenant Organization related to the header value as long as the organization is a member of the Global Admin Tool Organization.

Required Scope

content:read or content:write

📘
Pagination
The API takes a snapshot of the paginated set of books at the time of the first request. Paging through books goes through this fixed set of items. The snapshotted set becomes obsolete when a request has not been made for 2 minutes.

📘
Filters
When you filter by filter[external_id] or filter[url], the system always returns restricted content. Therefore, filtering by filter[include_restricted] is not useful in these cases.

Query Params

string

Retrieves the next batch of books. This value expires after 2 minutes if a request has not been made during that time.

limit

int32

Defaults to 100

The maximum number of books to display per page. A maximum of 1000 is allowed.

filter[start_date]

date

Filter criteria that returns content created from this date on. Format yyyy-mm-dd.

filter[end_date]

date

Filter criteria that returns content created before this date. Format yyyy-mm-dd.

filter[modified_before]

date

Filter criteria that returns content modified before this date. Format yyyy-mm-dd.

filter[modified_after]

date

Filter criteria that returns content modified after this date. Format yyyy-mm-dd.

filter[external_id]

integer

Filter criteria that only returns books with this external ID.

filter[internal_only]

boolean

Defaults to true

Filter criteria that only returns books internal to the organization.

filter[include_restricted]

boolean

Defaults to false

Filter criteria that only returns content restricted to administrative groups.

Note: When you filter by filter[external_id] or filter[url], the system always returns restricted content. Therefore, filtering by filter[include_restricted] is not useful in these cases.

filter[term]

string

Filter criteria that returns content that contains the keyword in the title, summary, or labels. Results are sorted with more popular and relevant results at the top of the response collection.

Headers

X-Degreed-Organization-Code

string

For Global Admin Tool Organizations, include this header in your request to retrieve content from the tenant organization. You must provide your organization code as the value. Contact your Degreed technical partner if you are unsure what your organization code is.

Response

xxxxxxxxxx
curl --request GET \
     --url 'https://api.betatest.degreed.com/api/v2/content/books?limit=100&filter[internal_only]=true&filter[include_restricted]=false' \
     --header 'accept: application/json'

Get All Books

Required Scope

📘
Pagination

📘
Filters

📘Pagination

📘Filters

200Success

📘
Pagination

📘
Filters