{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/oauth2/authorize","auth":"never","method":"get","params":[{"name":"client_id","type":"int","default":"","desc":"The application's client id","required":true,"in":"query","ref":"","_id":"543555cc3513400800a14755"},{"name":"redirect_uri","type":"string","default":"","desc":"The URL that the user will be redirected to after authorization. Must have the same domain as the application","required":true,"in":"query","ref":"","_id":"543555cc3513400800a14754"},{"name":"response_type","type":"string","default":"code","desc":"The authorization type (code)","required":true,"in":"query","ref":"","_id":"543555cc3513400800a14753"}],"results":{"codes":[{"status":200,"language":"text","code":"https://www.example.com/endpoint?code=1234567890","name":"Success"},{"status":400,"language":"text","code":"https://www.example.com/endpoint?error=invalid_client","name":"Failure"}]},"try":false,"basic_auth":false,"examples":{"codes":[]},"settings":"5d24a85d679189012c4d5dff"},"next":{"description":"","pages":[]},"title":"/oauth2/authorize","type":"endpoint","slug":"oauth2-authorize-get","excerpt":"Users will be sent to this URL to authorize your application. Once authorized, the user will be redirected to redirect_uri with a url encoded authorization code that will be required in the token endpoint","body":"Request an OAuth2 authorization code\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /api/v2/oauth2/authorize?client_id=1234&redirect_uri=http%3A%2F%2Fwww.example.com&response_type=code HTTP/1.1\\nHost: www.formstack.com\",\n      \"language\": \"http\"\n    },\n    {\n      \"code\": \"curl -i \\\"https://www.formstack.com/api/v2/oauth2/authorize?client_id=1234&redirect_uri=http%3A%2F%2Fwww.example.com&response_type=code\\\"\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\nTo request an OAuth2 token to use with the Formstack API explorer, visit [here](https://www.formstack.com/readme_auth.php).","updates":["5a65c419e9f8b3003ad03559","5a9b1dd2f013340012d56b0d","5bd3bb7428fc00003e89c7c3"],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"543555cc3513400800a14752","createdAt":"2014-10-08T15:18:36.969Z","editedParams2":true,"githubsync":"","parentDoc":null,"category":{"sync":{"isSync":false,"url":""},"pages":["5435626c5ff8a51a006e4110","543553953513400800a14736","543555cc3513400800a14752","54355bcc35740020002a1b3b","5434928b0ef9c0080016520e","54347c8e5b10711400c6c30a","54346f750ef9c00800164fa0","543470f45b10711400c6c1e5","543477b70ef9c0080016505b","543478fb5b10711400c6c29f","54347d105b10711400c6c318","54347df00ef9c008001650d2","54347edf5b10711400c6c336","54357a175e1b2020004380dc","543483520ef9c0080016512a","543484820ef9c0080016513a","5434887e5b10711400c6c3cd","543488c05b10711400c6c3d2","54348ac85b10711400c6c401","5434959c0ef9c0080016522d","543497030ef9c00800165244","543498ae5b10711400c6c4f6","54349b7f0ef9c00800165293","54349c070ef9c00800165298","54349dbf0ef9c008001652ad","5434ab8e0ef9c00800165384","5434abbb0ef9c0080016538f","5434ac495b10711400c6c626","5434ada40ef9c008001653a8","5434af0a0ef9c008001653bc","5434af5f0ef9c008001653c8","5434b00a5b10711400c6c66b","5434b0d15b10711400c6c68c","5434b1ee0ef9c00800165406","5434b26d0ef9c0080016541c","5434b3560ef9c00800165427","5434b3b40ef9c0080016545a","5434b49f008ec22200d86ab9","5434b51f008ec22200d86aca","5434b5a80ef9c0080016546f","5434b5f4008ec22200d86ad8","5434b676008ec22200d86add","5434b6e6008ec22200d86ae5"],"title":"REST API","slug":"rest-api","order":1,"from_sync":false,"reference":false,"_id":"5434918d0ef9c008001651ff","version":"54346a2a0ef9c00800164f28","__v":30,"project":"543469460ef9c00800164f0e","createdAt":"2014-10-08T01:21:17.804Z"},"editedParams":true,"project":"543469460ef9c00800164f0e","user":"543469060ef9c00800164f01","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54346a2b0ef9c00800164f29","543473445b10711400c6c21a","543473500ef9c00800164fde","54347c625b10711400c6c301","5434918d0ef9c008001651ff","5434b72c008ec22200d86ae7","5435990c495d5d0800f3a510","5b6af3dffc81e4000383db74"],"_id":"54346a2a0ef9c00800164f28","releaseDate":"2014-10-07T22:33:14.982Z","createdAt":"2014-10-07T22:33:14.982Z","forked_from":"543469460ef9c00800164f11","project":"543469460ef9c00800164f0e","__v":8},"__v":4,"is_link":false}

get/oauth2/authorize

Users will be sent to this URL to authorize your application. Once authorized, the user will be redirected to redirect_uri with a url encoded authorization code that will be required in the token endpoint

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

client_id:
required
integer
The application's client id
redirect_uri:
required
string
The URL that the user will be redirected to after authorization. Must have the same domain as the application
response_type:
required
stringcode
The authorization type (code)

Result Format


Documentation

Request an OAuth2 authorization code [block:code] { "codes": [ { "code": "GET /api/v2/oauth2/authorize?client_id=1234&redirect_uri=http%3A%2F%2Fwww.example.com&response_type=code HTTP/1.1\nHost: www.formstack.com", "language": "http" }, { "code": "curl -i \"https://www.formstack.com/api/v2/oauth2/authorize?client_id=1234&redirect_uri=http%3A%2F%2Fwww.example.com&response_type=code\"", "language": "shell" } ] } [/block] To request an OAuth2 token to use with the Formstack API explorer, visit [here](https://www.formstack.com/readme_auth.php).

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}