Getting started

API version
Select a version to change the base URI
in syntax and code examples. Learn about versions
:

The DreamApply API is enabled by default for most DreamApply instances. To access the API settings, in the main menu of the DreamApply portal, navigate to System > API.

If the API option is not available, the API might not be enabled for your instance. In this case, contact the DreamApply team for assistance.

Authentication and security

Learn how DreamApply secures API requests

Response codes

Review status codes that DreamApply returns

Testing

Understand which tools you can use to test API requests

API quota limits

Check the limits applied to manage request volumes

Best practices

Follow best practices to get the most of the DreamApply API

Versioning and changelog

Select API versions and review the changelog for updates

What's new

Review new API capabilities available the DreamApply API

DreamApply API

Authentication and security