{"id":15866159,"url":"https://github.com/braze-community/braze-specification","last_synced_at":"2026-04-18T06:32:59.595Z","repository":{"id":187109432,"uuid":"676327755","full_name":"braze-community/braze-specification","owner":"braze-community","description":"📖 Postman collection and OpenAPI spec for Braze API.","archived":false,"fork":false,"pushed_at":"2026-04-10T00:08:30.000Z","size":2329,"stargazers_count":2,"open_issues_count":3,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-04-10T02:21:50.706Z","etag":null,"topics":["braze","braze-api","braze-documentation","json","npm","openapi","postman-collection","spec","specification"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/braze-specification","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/braze-community.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-08-09T00:45:18.000Z","updated_at":"2026-04-10T00:08:33.000Z","dependencies_parsed_at":"2023-08-09T02:42:33.371Z","dependency_job_id":"810ac81b-43d2-4ff3-afac-d184dcdc0a8e","html_url":"https://github.com/braze-community/braze-specification","commit_stats":null,"previous_names":["braze-community/braze-specification"],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/braze-community/braze-specification","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braze-community%2Fbraze-specification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braze-community%2Fbraze-specification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braze-community%2Fbraze-specification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braze-community%2Fbraze-specification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/braze-community","download_url":"https://codeload.github.com/braze-community/braze-specification/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/braze-community%2Fbraze-specification/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31959880,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["braze","braze-api","braze-documentation","json","npm","openapi","postman-collection","spec","specification"],"created_at":"2024-10-05T23:04:43.435Z","updated_at":"2026-04-18T06:32:59.583Z","avatar_url":"https://github.com/braze-community.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# braze-specification\n\n[![NPM](https://nodei.co/npm/braze-specification.png)](https://nodei.co/npm/braze-specification/)\n\n[![NPM version](https://img.shields.io/npm/v/braze-specification.svg)](https://www.npmjs.com/package/braze-specification)\n[![build](https://github.com/braze-community/braze-specification/actions/workflows/build.yml/badge.svg)](https://github.com/braze-community/braze-specification/actions/workflows/build.yml)\n[![lint](https://github.com/braze-community/braze-specification/actions/workflows/lint.yml/badge.svg)](https://github.com/braze-community/braze-specification/actions/workflows/lint.yml)\n\nBraze API specification:\n\n- [OpenAPI spec](https://github.com/braze-community/braze-specification/blob/master/openapi/spec.json)\n- [Postman collection](https://github.com/braze-community/braze-specification/blob/master/postman/collection.json)\n\nSee the original [Postman collection](https://documenter.getpostman.com/view/4689407/SVYrsdsG).\n\n\u003e [!NOTE]\n\u003e _Disclaimer:_ This is a community-maintained project and is not officially endorsed by or affiliated with Braze, Inc.\n\n## Installation\n\n[NPM](https://www.npmjs.com/package/braze-specification):\n\n```sh\nnpm install braze-specification\n```\n\n[Yarn](https://yarnpkg.com/package/braze-specification):\n\n```sh\nyarn add braze-specification\n```\n\n## Usage\n\nRequire OpenAPI spec and Postman collection with CommonJS:\n\n```ts\nconst spec = require('braze-specification/openapi/spec.json');\nconst collection = require('braze-specification/postman/collection.json');\n```\n\nOr import OpenAPI spec and Postman collection with ES Modules:\n\n```ts\nimport spec from 'braze-specification/openapi/spec.json';\nimport collection from 'braze-specification/postman/collection.json';\n```\n\n## Contributing\n\nSee [contributing](https://github.com/braze-community/braze-specification?tab=contributing-ov-file).\n\n## License\n\n[MIT](https://github.com/braze-community/braze-specification/blob/master/LICENSE)\n\nBraze is a registered trademark of Braze, Inc. This project is not managed by Braze, Inc.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbraze-community%2Fbraze-specification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbraze-community%2Fbraze-specification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbraze-community%2Fbraze-specification/lists"}