--- title: Roster API slug: roster-api description: The Roster API lets brands ecommercebuild integrations that extend the platform. Access the API docs, API explorer, and OpenAPI spec. docTags: createdAt: 2024-12-06T22:59:03.021Z --- The Roster API allows brands to build integrations that extend and enhance the Roster experience. You can find the Roster API documentation [here](https://api.getroster.com/docs/v2/index.html). You can also use our [api explorer](https://api.getroster.com/swagger) in preparation for development, or download the OpenAPI specification to use in Postman or other OpenAPI-aware tools. :::Iframe{iframeHeight="0" code="

"} ::: ## API Access Tokens All API endpoints require either a public or private access token. It is critical that you never share a private access token with anybody who shouldn't have read/write access to ALL of your Roster data. This includes never using a private access token in a front-end client, such as your brand's website or online store. ### Public Access Tokens Public access tokens are intended to be used in public, insecure environments, such as a browser. These token can only be used with two endpoints for capturing link clicks and orders. Refer to the API docs for details on these two endpoints. ### Private Access Tokens Private access tokens provide read/write access to a significant amount of private account data. As such, private access tokens should only be used in secure, trusted environments (e.g. server-side) and should never be shared with anybody (including 3rd parties) with whom you wouldn't want to have read/write access to your Roster data. ### Create and Manage Access Tokens You can add, copy, and remove public and private access tokens from within your Roster account. :::::WorkflowBlock :::WorkflowBlockItem ### Access the integrations section in Roster 1. Click on the `Brand Logo` located at the bottom of the window. 2. Click on `Integrations` > `API integration` ::: :::WorkflowBlockItem ### Create a new access token 1. Click the `New access token` button and select whether you want to create a public or a private access token. 2. Click the `Copy` icon next to the newly generated token to copy it to your clipboard. ::: ::::WorkflowBlockItem ### Expire an access token 1. Click the `...` more menu for the access token you want to expire 2. Select `Expire token` from the menu and confirm that you want to delete the token. :::hint{type="info"} All Roster accounts linked to a Shopify store have a default Public Access Token which cannot be expired as this is the token that is automatically added to your store's pages to track link clicks and referred orders. ::: :::: ::::: *** ## Need help? If you have any questions or need assistance, please reach out to our support team at [support@getroster.com](mailto\:support@getroster.com).