REST API

REST API

Updated: December 19, 2019

This page is scheduled for review and update. Check back soon for updated content!

The Nuxeo REST API is available on a Nuxeo Server.
All endpoints follow the URL:

https://NUXEO_SERVER/nuxeo/api/v1/ENDPOINT

This page explains the organization and scope of the existing endpoints and other additional mechanisms which extend the behavior of the API.

Nuxeo University
Watch the related course on Nuxeo University.

Example

Get the default-domain document by its path:

curl -u Administrator:Administrator  https://nightly.nuxeo.com/nuxeo/api/v1/path/default-domain

Scope and Concepts

The Nuxeo REST API is the best way to remotely integrate portals, workflow engines, Enterprise Service Bus (ESBs) and custom applications written in JavaScript, Ruby, etc, with a Nuxeo Server.

See Endpoints for more detailed information on the provided endpoints and how to contribute your own.

Additional Features

The Nuxeo REST API offers several additional features compared to a standard REST API:

  • The use of Content enrichers in request headers which allow you to request more information with the returned resources (for example, receiving all of a document's children in addition to the document itself).
  • The use of Web Adapters which transform the resources returned (for example, getting all the tasks of a document, or its related documents).
  • The ability to pipe command calls on a resource.

Learn More

Available Client SDKs

We provide several client SDKs to make it even easier to use the API integrated with the Nuxeo Platform:

We'd love to hear your thoughts!

All fields required