Every request to the Web API v3 needs an access token. This article explains how to get one and which scopes to ask for.
Part of Web API v3 for user management.
How authentication works
To connect with the API in a secure way we support OAuth2 with the Client Credentials Grant flow.
A client_id, client_secret and scope are needed to request an access token that can be used for authentication.
Getting your credentials
To request a client_id and client_secret, contact Quinn or email service@tinqwise.com. Please specify which scopes you require.
Requesting a token
Using your client_id and client_secret, request an authorization token using the Token URL.
Click the Authorize button in your interactive documentation to see your token URL.
[đ¸ SCREENSHOT: The interactive documentation page with the Authorize button highlighted, showing where the Token URL appears]
This token is necessary when you send a request to our API.
đ§ Be careful
The scope for which the token is provided should match the scope for the API you are trying to use. Tokens are only active for a limited amount of time.
Read and write scopes
There are two scopes for each endpoint, for example v3:users:read and v3:users:write.
The
readscope is required forGETrequests.The
writescope is required forPUT,POST,PATCHandDELETErequests.
Available scopes
v3:users:readv3:users:writev3:groups:readv3:groups:writev3:groupmemberships:readv3:groupmemberships:writev3:permissions:readv3:permissions:writev3:activation_token:readv3:activation_token:writev3:budgets:readv3:budgets:writev3:todos:readv3:todos:write
For a working request example, see the Python example in Web API v3 for user management.