braze-specification

November 15, 2025 ยท View on GitHub

NPM

NPM version build lint

Braze API specification:

See the original Postman collection.

Note

Disclaimer: This is a community-maintained project and is not officially endorsed by or affiliated with Braze, Inc.

Installation

NPM:

npm install braze-specification

Yarn:

yarn add braze-specification

Usage

Require OpenAPI spec and Postman collection with CommonJS:

const spec = require('braze-specification/openapi/spec.json');
const collection = require('braze-specification/postman/collection.json');

Or import OpenAPI spec and Postman collection with ES Modules:

import spec from 'braze-specification/openapi/spec.json';
import collection from 'braze-specification/postman/collection.json';

Contributing

See contributing.

License

MIT

Braze is a registered trademark of Braze, Inc. This project is not managed by Braze, Inc.