{"id":24258201,"url":"https://github.com/splitpass/mindbody-api","last_synced_at":"2025-09-23T20:30:55.709Z","repository":{"id":61342699,"uuid":"550758265","full_name":"SplitPass/mindbody-api","owner":"SplitPass","description":"Type safe library for interacting with Mindbody's Public API (v6) and Webhooks","archived":false,"fork":false,"pushed_at":"2024-07-07T08:43:25.000Z","size":187,"stargazers_count":10,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-11T07:06:28.558Z","etag":null,"topics":["api","mindbody","mindbody-api","nodejs"],"latest_commit_sha":null,"homepage":"","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/SplitPass.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-13T09:25:01.000Z","updated_at":"2024-12-08T08:18:41.000Z","dependencies_parsed_at":"2024-10-06T13:56:06.913Z","dependency_job_id":"3228c092-9fb8-4883-b2d7-9181e3b69d91","html_url":"https://github.com/SplitPass/mindbody-api","commit_stats":{"total_commits":40,"total_committers":2,"mean_commits":20.0,"dds":"0.050000000000000044","last_synced_commit":"f20276fed39106b742135733b5ae4ed6d672338f"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplitPass%2Fmindbody-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplitPass%2Fmindbody-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplitPass%2Fmindbody-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SplitPass%2Fmindbody-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SplitPass","download_url":"https://codeload.github.com/SplitPass/mindbody-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233994946,"owners_count":18762956,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["api","mindbody","mindbody-api","nodejs"],"created_at":"2025-01-15T05:31:52.737Z","updated_at":"2025-09-23T20:30:55.268Z","avatar_url":"https://github.com/SplitPass.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv\u003e\n    \u003ch1\u003eMindbody API\u003c/h1\u003e\n    \u003cp\u003e\u003cb\u003eType safe library for interacting with Mindbody's Public API (v6) and Webhooks\u003c/b\u003e\u003c/p\u003e\n    \u003cimg src=\"https://img.shields.io/github/package-json/v/splitpass/mindbody-api?color=blue\u0026style=for-the-badge\" alt=\"Latest version of splitpass/mindbody-api is 0.2.3\"\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\n\u003e :warning: **Read before installing**\\\n\u003e This library is typed according to the definitions available in Minbody's [API docs](https://developers.mindbodyonline.com/PublicDocumentation/V6#endpoints). Their API fails to establish consistent patterns and field type definitons. An `ID` may be typed as a `string` or `number` and commonly swaps to a different type depending on the endpoint. Schema definitions are sometimes incomplete or completely wrong. Schema fields and endpoint paramters are only sometimes marked as nullable / optional. **Please keep all this in mind when using this library. SplitPass uses this library internally (heavily) and we will correct / expand type definitions as we run accross issues. BUT, we do not interact with 100% of Mindbody's API. Please submit an issue or PR if you find an issue or would like to expand a type definition (ex. make a field nullable or query param / payload param optional)**\n\nThe package includes all endpoints added before or during the **September 2022 release**.\n\nPRs are welcome if we are behind the release schedule and you would like to use a new endpoint that was added\n\nhttps://developers.mindbodyonline.com/Resources/ApiReleaseNotes\n\n## Requirements\n\nNode 12.4 or higher.\n\n## Installation\n\nInstall the package with:\n\n```sh\nnpm install mindbody-api-v6 --save\n# or\nyarn add mindbody-api-v6\n```\n\n## Usage\n\nMindbody requires an **API key** to interact with endpoints and **may additionally\nrequire a token generated from your staff credentials**.\nActions such as adding clients to a class require a user token\nincluded in the request headers. Tokens may only be generated for locations\nthat have explicitly granted you permission. Some endpoints may limit the\ndata returned if no token is provided.\n\nhttps://developers.mindbodyonline.com/\n\n```ts\nimport { Config } from 'mindbody-api-v6';\n\nConfig.setup({\n  apiKey: '',\n});\n// or\nConfig.setup({\n  apiKey: '',\n  username: '',\n  password: '',\n});\n```\n\n### Example\n\nEndpoints are logically separated based on the categories listed [here](https://developers.mindbodyonline.com/PublicDocumentation/V6#endpoints).\n\n```ts\nimport { Class, Client, Staff, Webhooks } from 'mindbody-api-v6';\n\nconst classes = await Class.getClassSchedules({\n  siteID: '123',\n  params: {\n    StartDate: '2022-01-01',\n    LocationIds: [1, 2],\n  },\n});\n\nconst newClient = await Client.addClient({\n  siteID: '123',\n  payload: { ... }\n})\n\n/**\n * Endpoints with optional parameters\n * or payloads may exclude the field\n */\nconst staff = await Staff.getStaff({\n  siteID: '123',\n  // Automatically page through all results.\n  // Only applicable for paginated endpoints\n  autoPaginate: true,\n});\n\n/**\n * Interact with Webhooks API\n *\n * https://developers.mindbodyonline.com/WebhooksDocumentation\n */\nawait Webhooks.Subscriptions.createSubscription({ ... });\n```\n\n### Types\n\nAll model definitions are exported under `MBType`. A full list of models can be found [here](https://developers.mindbodyonline.com/PublicDocumentation/V6#shared-resources). Additional models were added for easy access to complex types not listed in Mindbody's documentation\n\n```ts\nimport type { MBType, MBWebhookType } from 'mindbody-api-v6';\n\nconst staff: MBType.Staff = ...;\nconst client: MBType.Client = ...;\n// Webhook event types\nconst newClient: MBWebhookType.ClientCreated = ...;\n```\n\n## Roadmap\n\n| Version | Features                       |\n| ------- | ------------------------------ |\n| 1.0.0   | Test coverage, type refinement |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplitpass%2Fmindbody-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplitpass%2Fmindbody-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplitpass%2Fmindbody-api/lists"}