{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/authorize","auth":"never","params":[{"name":"response_type","type":"string","default":"","desc":"Whether the endpoint returns an authorization code. For web applications, a value of code should be used","required":true,"in":"query","ref":"","_id":"55bad720d0736b3100bf101e"},{"name":"client_id","type":"string","default":"","desc":"The client_id of your application","required":true,"in":"query","ref":"","_id":"55bad720d0736b3100bf101d"},{"name":"redirect_uri","type":"string","default":"","desc":"A URI where the response will be redirected","required":true,"in":"query","ref":"","_id":"55bad79d3f0767230008f515"},{"name":"scope","type":"string","default":"","desc":"A space-separated list of [scopes](doc:scopes)","required":true,"in":"query","ref":"","_id":"55bad79d3f0767230008f514"},{"name":"state","type":"string","default":"","desc":"An arbitrary string value we will pass back to you, useful for [CSRF protection](http://www.twobotechnologies.com/blog/2014/02/importance-of-state-in-oauth2.html)","required":false,"in":"query","ref":"","_id":"55cbc07e50046e3700d91068"}],"results":{"codes":[{"language":"text","code":""}]},"settings":"","examples":{"codes":[{"code":"<?php\n\n$query = http_build_query([\n  'response_type' => 'code',\n  'client_id' => 'YOUR_CLIENT_ID',\n  'redirect_uri' => 'YOUR_CLIENT_REDIRECT_URI',\n  'scope' => 'donations.read'\n]);\n\nheader(\"Location: https://streamlabs.com/api/v1.0/authorize?$query\");\nexit;\n","language":"php"},{"name":"Sample URL","language":"text","code":"https://www.twitchalerts.com/api/v1.0/authorize?client_id=CLIENT_ID_HERE&redirect_uri=REDIRECT_URI_HERE&response_type=code&scope=legacy.token+donations.read"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"/authorize","type":"endpoint","slug":"authorize","excerpt":"In order to acquire an **access_token** for a user, you'll need to send them to this endpoint in order to approve your application. [Click here for more information.](doc:connecting-to-an-account)","body":"","updates":["56c1fb49d9e8a90d00f88918","56c3bb6e4040602b0064ce8e","57535b286584690e0072eda6","57a55ad11344c40e003321fa","5881d068bc00701b00a6ce52","588f3731bcace50f0052b8eb","588fbf0f3a96f12500b031f9","5890a7cad6cb8e2500a3f256","5892c2f43a266c0f00f10cfe","58939798268acb3d00798f8e","58959a58448a480f00764447","589fe1b11233cd0f00b796b3","58a59a58d498872f0022e3db","58a9aa20a790600f000e88a8","58cebcd9e440870f007854ef","58cebd17d59b860f002dbcf7","58cec9cd0d70032300a8737e","58e265f0ad0b3d2700139182","5a80b37fea6667001224c6b4"],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55bad5423f0767230008f510","parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":["55baf6961b0d663700781673","55baf6e31b0d663700781676"],"title":"Authentication","slug":"authentication","order":1,"from_sync":false,"reference":true,"_id":"55baf4151b0d66370078166f","version":"55baca9cd0736b3100bf100b","__v":2,"project":"55baca9cd0736b3100bf1008","createdAt":"2015-07-31T04:05:41.090Z"},"createdAt":"2015-07-31T01:54:10.763Z","editedParams2":true,"user":"55baca333f0767230008f4ff","__v":24,"editedParams":true,"githubsync":"","project":"55baca9cd0736b3100bf1008","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55baca9dd0736b3100bf100c","55bacba0d0736b3100bf1017","55bad8f33f0767230008f517","55baf3f01b0d66370078166e","55baf4151b0d66370078166f","55f1cca35fe76419007dc794","573e2d6e610a090e00ca2b97","58d97ce57718211b0028e6bc","599b510cb683b50031a35299","5a871c493948fd004697e677"],"_id":"55baca9cd0736b3100bf100b","createdAt":"2015-07-31T01:08:44.540Z","project":"55baca9cd0736b3100bf1008","__v":10,"releaseDate":"2015-07-31T01:08:44.540Z"}}

get/authorize

In order to acquire an **access_token** for a user, you'll need to send them to this endpoint in order to approve your application. [Click here for more information.](doc:connecting-to-an-account)

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

response_type:
required
string
Whether the endpoint returns an authorization code. For web applications, a value of code should be used
client_id:
required
string
The client_id of your application
redirect_uri:
required
string
A URI where the response will be redirected
scope:
required
string
A space-separated list of [scopes](doc:scopes)
state:
string
An arbitrary string value we will pass back to you, useful for [CSRF protection](http://www.twobotechnologies.com/blog/2014/02/importance-of-state-in-oauth2.html)

Examples