https://github.com/braze-community/braze-specification
📖 Postman collection and OpenAPI spec for Braze API.
https://github.com/braze-community/braze-specification
braze braze-api braze-documentation json npm openapi postman-collection spec specification
Last synced: 3 months ago
JSON representation
📖 Postman collection and OpenAPI spec for Braze API.
- Host: GitHub
- URL: https://github.com/braze-community/braze-specification
- Owner: braze-community
- License: mit
- Created: 2023-08-09T00:45:18.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2026-04-10T00:08:30.000Z (3 months ago)
- Last Synced: 2026-04-10T02:21:50.706Z (3 months ago)
- Topics: braze, braze-api, braze-documentation, json, npm, openapi, postman-collection, spec, specification
- Language: TypeScript
- Homepage: https://npmjs.com/package/braze-specification
- Size: 2.22 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# braze-specification
[](https://nodei.co/npm/braze-specification/)
[](https://www.npmjs.com/package/braze-specification)
[](https://github.com/braze-community/braze-specification/actions/workflows/build.yml)
[](https://github.com/braze-community/braze-specification/actions/workflows/lint.yml)
Braze API specification:
- [OpenAPI spec](https://github.com/braze-community/braze-specification/blob/master/openapi/spec.json)
- [Postman collection](https://github.com/braze-community/braze-specification/blob/master/postman/collection.json)
See the original [Postman collection](https://documenter.getpostman.com/view/4689407/SVYrsdsG).
> [!NOTE]
> _Disclaimer:_ This is a community-maintained project and is not officially endorsed by or affiliated with Braze, Inc.
## Installation
[NPM](https://www.npmjs.com/package/braze-specification):
```sh
npm install braze-specification
```
[Yarn](https://yarnpkg.com/package/braze-specification):
```sh
yarn add braze-specification
```
## Usage
Require OpenAPI spec and Postman collection with CommonJS:
```ts
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:
```ts
import spec from 'braze-specification/openapi/spec.json';
import collection from 'braze-specification/postman/collection.json';
```
## Contributing
See [contributing](https://github.com/braze-community/braze-specification?tab=contributing-ov-file).
## License
[MIT](https://github.com/braze-community/braze-specification/blob/master/LICENSE)
Braze is a registered trademark of Braze, Inc. This project is not managed by Braze, Inc.