Getting started on DreamApply Knowledge Base

Authentication and security

Mon, 01 Jan 0001 00:00:00 +0000

HTTPS

The first prerequisite for securing the API is HTTPS, which is automatically enabled for all DreamApply instances.

HTTPS is HTTP over TLS. TLS provides both confidentiality and integrity for transmitted data ensured through mechanisms such as HMAC.

Because all API communication occurs over a secure channel, the DreamApply API design can remain simpler. For example, DreamApply does not require a complicated custom HMAC scheme (as used by some APIs, such as Amazon Web Services) or additional mechanisms, such as transmitting nonces with each request to prevent replay attacks.

Response codes

Mon, 01 Jan 0001 00:00:00 +0000

The DreamApply API uses standard HTTP status codes to communicate the results of API requests. The codes below outline the general logic of status codes across the system. For more specific code meanings for individual API requests, see the API reference.

Success

Code	Description
`200 OK`	The generic success code.
`201 Created`	A typical response for the `POST` request. A new resource was created, and the response includes a reference to the created resource.
`204 No Content`	A typical response for `PUT` and `DELETE` requests. The response was completed, but there is no response body.

Error

Code	Description
`400 Bad Request`	The request parameters or body fail validation, for example, the ID is not in the correct format or some of the filtering parameters are invalid.
`401 Unauthorized`	The request authentication failed; the DreamApply API key is missing, expired or invalid. For details, see Authentication and security.
`404 Not Found`	A requested resource cannot be found. Typically indicates that the resource (generally identified by its ID) does not exist. If you issue multiple `DELETE` requests for the same resource, you will receive this error on any subsequent requests.
`409 Conflict`	A request cannot be completed due to a conflict, for example, a flag or tracker with the same ID already exists or an applicant with the same email address is already registered.
`429 Too Many Requests`	Too many requests were sent in a short period of time. For details, see API quota limits.
`500 Internal Server Error`	The server has encountered an error while processing the request. The issue is not caused by the client, and the client may retry the request. If the error persists for the same request, contact the DreamApply team with the request details.

Testing

Mon, 01 Jan 0001 00:00:00 +0000

Although the DreamApply API uses standard HTTP requests, you cannot test and debug them from a browser address bar. All requests must include the Authentication header.

To test and debug API requests, use a REST client that supports requests headers, for example, command-line tools like cURL or IDE extensions that send HTTP requests.

API quota limits

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply limits the number of API requests that you can make over a specific period of time. These limits help prevent API abuse and maintain stable usage for all DreamApply clients.

Request quotas

By default, all API requests using the same API key are limited to 180 requests per minute.

A limit of 180 requests per minute does not mean that requests must be spaced evenly, for example, three requests per second. DreamApply calculates the total number of requests within the time window. A rapid succession of requests is allowed, but it can exhaust your quota more quickly.

Best practices

Mon, 01 Jan 0001 00:00:00 +0000

To use the DreamApply API efficiently, follow the recommendations below. These techniques help optimize performance, reduce network traffic and make integrations with DreamApply more reliable.

Use filter parameters efficiently

Use filtering parameters to limit the amount of returned data. By applying filters, you can retrieve only the records relevant to your use case.

Filter indicators: Parameters starting with by indicate a filter. For example, byStatuses=Online filters for the Online status.
Logical OR: Lists in filtering parameters are combined with a logical OR operator. Lists can be comma-separated or space-separated. For example, GET /api/courses?byStatuses=Online,Standby returns courses where the status is either Online or Standby.
Logical AND: Different filtering parameters are combined with a logical AND operator. For example, GET /api/courses?byStatuses=Online&byTypes=UG returns courses where the status is Online and the type is Undergraduate.

Use the expand parameter

For some collections and resources, the DreamApply API offers the expand parameter. Use it to retrieve related entities in a single request instead of making multiple follow-up requests. expand is especially useful when you need associated data, such as applicant’s trackers, documents or invoices, together with the primary resource.

Versioning and changelog

Mon, 01 Jan 0001 00:00:00 +0000

API versioning

The API version number only increments when backwards-incompatible changes are introduced or when the semantics or structure of data change significantly. For example, adding new data, such as a new field in the application, does not necessarily require a new version, as long as existing clients continue to work without disruption.

Maintaining backward compatibility is a high priority for DreamApply. However, when breaking changes are required, earlier API versions remain available for a limited time to allow clients to migrate.

What's new in DreamApply API

Mon, 01 Jan 0001 00:00:00 +0000

Stay up-to-date with the new API features and capabilities available in the latest and previous versions of the DreamApply API. If you are looking for a concise, version-by-version summary of important updates, see the Changelog.

Getting started on DreamApply Knowledge Base

Authentication and security

HTTPS

Response codes

Success

Error

Testing

API quota limits

Request quotas

Best practices

Use filter parameters efficiently

Use the expand parameter

Versioning and changelog

API versioning

What's new in DreamApply API

May 2026

Invoice management Version: All

Scoring explanation in offers Version: 9