{"_id":"55e58b66d101191900f30b19","__v":10,"parentDoc":null,"version":{"_id":"55e58b63d101191900f30b16","__v":3,"project":"55e58b63d101191900f30b13","createdAt":"2015-09-01T11:26:27.668Z","releaseDate":"2015-09-01T11:26:27.668Z","categories":["55e58b65d101191900f30b17","55e58d16f493c11700584314","55e58d1bd101191900f30b1d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"5554788cb450630d00041dbc","category":{"_id":"55e58b65d101191900f30b17","__v":2,"project":"55e58b63d101191900f30b13","pages":["55e58b66d101191900f30b19","55e69fa6e2cbe717004eb750"],"version":"55e58b63d101191900f30b16","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-01T11:26:29.354Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"project":"55e58b63d101191900f30b13","updates":["568ce7aa13c5ad0d00b34eba","56fefb153734f60e000bc468","585d25c078037c0f007cffea"],"next":{"pages":[],"description":""},"createdAt":"2015-09-01T11:26:30.628Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[PushCrew](https://pushcrew.com/) is a powerful new way of communicating with users. It allows websites on desktop and mobile to send push notifications to users. The notifications appear even when the user is not on the website, so they make for a great way to inform users and make them take actions (by clicking on notifications). \n\nThis document will help you understand the basics of the PushCrew API.\n\nThe **JavaScript API** allows you to control subscriptions of individual subscribers. It can be used to:\n\n  * Trigger opt-in boxes for subscribing to push notifications\n  * Get current subscriber details (including unique ID)\n  * Add subscribers to segments\n  * Remove subscribers from segments\n\nThe **REST API** can be used to:\n\n  * Send notifications to all subscribers/a list of subscribers/subscribers belonging to a particular segment, or even a particular subscriber\n  * Add or remove subscribers from segments\n  * Check reports of previous notification requests\n\nGet started by reading [basics of how PushCrew works](https://pushcrew.readme.io/docs/how-does-pushcrew-work) and then explore our JavaScript and REST API.","excerpt":"This page will help you get started with PushCrew API's. You'll be up and running in a jiffy!","slug":"getting-started","type":"basic","title":"Getting Started with PushCrew"}

Getting Started with PushCrew

This page will help you get started with PushCrew API's. You'll be up and running in a jiffy!

[PushCrew](https://pushcrew.com/) is a powerful new way of communicating with users. It allows websites on desktop and mobile to send push notifications to users. The notifications appear even when the user is not on the website, so they make for a great way to inform users and make them take actions (by clicking on notifications). This document will help you understand the basics of the PushCrew API. The **JavaScript API** allows you to control subscriptions of individual subscribers. It can be used to: * Trigger opt-in boxes for subscribing to push notifications * Get current subscriber details (including unique ID) * Add subscribers to segments * Remove subscribers from segments The **REST API** can be used to: * Send notifications to all subscribers/a list of subscribers/subscribers belonging to a particular segment, or even a particular subscriber * Add or remove subscribers from segments * Check reports of previous notification requests Get started by reading [basics of how PushCrew works](https://pushcrew.readme.io/docs/how-does-pushcrew-work) and then explore our JavaScript and REST API.