Changes

Jump to navigation Jump to search

API V2.0

43 bytes added, 08:53, 5 June 2023
The API V2 changelog is [[API_V2.0_changelog|available here]].
= FAQ===How do I access API V2?==Create an invite code under Settings -> Apps & Integrations -> API. Exchange this invite code for a refresh token and token using the POST /authentication/setup endpoint. Include the token in your requests to authenticate them. 
==How long do invite codes/tokens last?==
Invite codes expire after 15 minutes.
Refresh tokens last forever so long as they are being used. Unused refresh tokens expire after 30 days.
Unused refresh tokens Tokens expire after 30 days24 hours.
==What are scopes?==Scopes limit what your token can do. For example, the read/bookings scope allows your token to retrieve bookings via the API, but if your token does not have the write/bookings scope then it cannot be used to create or modify bookings. ==Where are scopes set?==Scopes are set when you create an invite code. Scopes cannot be changed later, you must create a new invite code with the scopes you want and exchange it for a new token. ==How big are tokens?==Tokens expire after 24 hours.will be between 152 and 172 characters long
==What is the API credit limit?==
==Can I use API V2 to send pictures or webhooks?==
Currently no, however these features are coming soon.
 
==What are scopes?==
Scopes limit what your token can do.
 
For example, the read/bookings scope allows your token to retrieve bookings via the API, but if your token does not have the write/bookings scope then it cannot be used to create or modify bookings.
 
==Where are scopes set?==
Scopes are set when you create an invite code.
 
Scopes cannot be changed later, you must create a new invite code with the scopes you want and exchange it for a new token.
 
==How do I get a token/refresh token?==
Create an invite code under Settings -> Apps & Integrations -> API.
 
Exchange this invite code for a refresh token and token using the POST /authentication/setup endpoint.
 
==How big are tokens?==
Tokens will be between 152 and 172 characters long

Navigation menu