Sign in

v1

latestOpenAPI 3.0.12026-07-24283883639.5 KB
Content - Books

Get All Books

This endpoint retrieves all books for the current organization. <br><br>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. <h3>Required Scope</h3>content:read or content:write

get/api/v2/content/books

Query parameters

nextstring

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

limitinteger

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

filter[start_date]string date

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

filter[end_date]string date

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

filter[modified_before]string date

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

filter[modified_after]string 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

Filter criteria that only returns books internal to the organization.

filter[include_restricted]boolean

Filter criteria that only returns content restricted to administrative groups.<br><br>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
Example:keyword

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-Codestring
Example:tenant_organization_code

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

Success

Example response

{
  "data": [
    {
      "attributes": {
        "groups-with-access": [],
        "groups-with-access-ids": []
      }
    }
  ]
}