Postman Collection

The documentation provided as part of this Postman collection is for convenience and may not include the complete, or most up-to-date information about the 7shifts API. For the complete documentation, see our 7shifts API reference documents

This postman collection is based on the version 2023-04-01

Getting started with Postman

Postman is an API platform for building and using APIs. You can use this tool for making API calls against 7shifts API endpoints. To learn more about this tool and to download it, see the Postman website.

Postman Collection

You can download the postman collection based on the version 2023-04-01 here.

Using the Collection

Importing the collection

1. Once you have download the postman collection, unzip the file.
2. To import the collection, in Postman go to File > Import
3. Select the download .json collection file or drag and drop it on the import window. For more information on postman collections see the Postman learning center.
4. Select the collection 7Shifts Public API v2023-04-01 and click import.

Configuring authentication

1. Under the Collections, select the collection 7Shifts Public API v2023-04-01
2. Select on the Authorization Tab on the collection.

For Access Tokens

1. Se the authentication Type to Bearer Token
2. Paste your access token in the token input box. If you don't have an access token reference our authentication guide.
3. Your collection is now set to make API requests.

For OAuth Clients

1. Se the authentication Type to Oauth 2.0
2. Navigate to the Configuration Options section
   1. Set the Token Name, example 7shifts API token
   2. Set the Grant Type to Client Credentials
   3. Set the Access Token URL to http://7shifts.test/oauth2/token
   4. Set the Client ID to your OAuth client ID. If you don't have an access token reference our OAuth guide.
   5. Set the Client Secret to your client secret.
   6. Set the scope to v1_access companies:read companies:write locations:read locations:write users:read users:write departments:read departments:write roles:read roles:write sales:read sales:write shifts:read shifts:write time_punches:read time_punches:write events:read events:write
   7. Set the Client Authentication to Send as Basic Auth Header
3. Navigate to the Variables tab on the Collection configuration
   1. Set the xCompanyGuid variable to the company guid you wish to make calls against. NOTE: if you are using an access token this is not required.
4. Your collection is now set to make API requests.