Skip to main content
Skip table of contents

XNAT API Documentation

This Confluence wiki space exists to display XNAT API and API for XNAT plugins in an interactive way. It also contains simple tutorials on using the XNAT API to communicate with your XNAT and perform many operations.


This table contains a directory of API that can be found in Core XNAT.

/xapi vs /data vs /data/archive vs /REST

In legacy XNAT REST APIs, the following prefixes can be used interchangeably:

  • /REST

  • /data

  • /data/archive

These prefixes are not interchangeable with Swagger-enabled XAPI rest paths. These can only use:

  • /xapi

XNAT Administration

Site Administration

Site-wide Configuration API


Preference Service API


Data Type Schema API


Legacy XNAT Site Configuration API


System Administration

User Administration

User Management API


User Management API (Deprecated)


User Resources API


Project User Access API


Project Access Request API


Data Access API


User Authentication Services

User Session Management API


User Auth Service API


User Alias Token API


XNAT Event Service Administration

Event Service API



Event Tracking Data API


XNAT Plugin Administration

Plugin API


Plugin Open URL Authorization API


UI configuration:

UI Element Spawner API


UI Theme API (beta)


DICOM Connections:

Other Services:

File Mover Service API


Mail Send API


Audit Service API


Catalog Refresh API


Email Verification API


Features API


XNAT Data Management API

Working With Projects

Project API


Project Attributes API


Project Investigators API


Project User Access API


Project Access Request API


Project Configuration API


Project Pipeline Management API


Working with Subjects, Image Sessions and other Subject Assessors

Subject API


Experiment API
("Subject Assessors" API)


Experiment Quarantine API


Image Session Scans API


Image Assessor API


Data Sharing API


Scan Snapshot Generation API


Storing And Retrieving Resource Files

Project Resources and Files API


Subject Resource API


Experiment Resource API


Image Scan Resource API


Image Assessor Resource API

/data/.../assessors/{ID}/{IN | OUT}/resources

Resource Quarantine API


Using and Managing the Archive & Prearchive

Image Session Import Service API


Image Session Archive Service API


Prearchive API


Image Session Upload Status API


DICOM Dump Service API


Archive Processor API


Custom DICOM Mapping API





Stored Search API


XNAT Data Processing

XNAT Pipeline API


XNAT Project Pipeline API (Deprecated)


XNAT Workflow API


Related: Container Service API

XNAT Automation API

Event Handler API (beta)


XNAT Automation Service API (beta)


Deprecated API

These API are from legacy XNAT versions and have been replaced.

Site Administration

  • XNAT Site Configuration API - /REST/config

  • XNAT Site Settings API - /REST/services/settings

  • XNAT Log Reporting API - /REST/services/logging

  • XNAT Version - /REST/version

  • Search Fields - /REST/search/fields

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.