API Versioning

About the Bugcrowd API

We are excited to be developing a whole new API for interacting with the Bugcrowd platform programmatically. This set of documents relates entirely to the new API. If you’re looking for docs for our existing (v3) API, you can check them out here.

We’ll be rolling out the new API very soon. For now, if you’d like to start trying it out please reach out to request access.

Accept Header

To request resources from the Bugcrowd API, please include either of the following Accept headers in the request.

Accept: application/json
Accept: application/vnd.bugcrowd.v4+json
# Temporary placeholder until date-based versioning released

Content Types

The Bugcrowd API always returns the following Content-Type header.

Content-Type: application/json

Markdown Properties

Some Bugcrowd resources use Markdown fields to allow for rich text functionality. Markdown fields can be retrieved or set in Markdown format only. Check the specific API doc page for each resource to see more information about Markdown enabled fields.

Additional Media Headers

Each response from the API will contain a custom Bugcrowd header specifying the type of media returned in the response body:

X-Bugcrowd-Media-Type: bugcrowd.v4; format=json

API