{"_id":"5a60f64d792a330012d72148","category":{"_id":"5a60f64d792a330012d72142","version":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-02-25T18:51:47.436Z","from_sync":false,"order":2,"slug":"authorization-endpoints","title":"Authorization Endpoints"},"parentDoc":null,"project":"54ee19c23749bf0d00c76515","user":"54ee197f67e09c230091e707","version":{"_id":"5a60f64d792a330012d72140","project":"54ee19c23749bf0d00c76515","__v":2,"createdAt":"2018-01-18T19:32:29.915Z","releaseDate":"2018-01-18T19:32:29.915Z","categories":["5a60f64d792a330012d72141","5a60f64d792a330012d72142","5a60f64d792a330012d72143","5a60f64d792a330012d72144","5a60f64d792a330012d72145","5a60f64d792a330012d72146","5a60f64d792a330012d72147","5a660cc7dc0f1c001c2b5568"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"githubsync":"","__v":15,"updates":["5a3d6c34569283003262091c"],"next":{"pages":[],"description":""},"createdAt":"2015-02-25T20:31:53.956Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -H \"Content-Type: application/json\" -X POST -d '{\"email\":\"user:::at:::emailaddress.com\",\"password\":\"hunter2\"}' https://breezy.hr/public/api/v3/signin","language":"curl"}]},"method":"post","results":{"codes":[{"status":200,"name":"","code":"{\n    \"access_token\": \"00000000-0000-0000-0000-000000000000\",\n    \"user\": { User }\n}","language":"json"},{"name":"Missing Email Address","code":"{\n    \"error\": {\n        \"type\": \"signinEmailError\",\n        \"message\": \"email is null or empty\"\n    }\n}","language":"json","status":400},{"code":"{\n    \"error\": {\n        \"type\": \"signinPasswordError\",\n        \"message\": \"password is null or empty\"\n    }\n}","name":"Missing Password","status":400,"language":"json"},{"status":401,"language":"json","code":"{\n    \"error\": {\n        \"type\": \"signinFailure\",\n        \"message\": \"email or password incorrect.\"\n    }\n}","name":"Signin Failure"},{"code":"{\n    \"error\": {\n        \"type\": \"accessTokenCreationError\",\n        \"message\": \"There was an error creating Access Token.\"\n    }\n}","language":"text","status":500}]},"settings":"","auth":"never","params":[{"_id":"54ee34ed8dafa7250027e6dd","ref":"","in":"body","required":true,"desc":"Email address of user","default":"","type":"string","name":"email"},{"_id":"54ee34ed8dafa7250027e6dc","ref":"","in":"body","required":true,"desc":"Password of user","default":"","type":"string","name":"password"}],"url":"/v:version/signin"},"isReference":true,"order":0,"body":"The activation token is valid for 30 days.","excerpt":"Retrieve an access token. Use the access_token as part of the Authorization header.","slug":"signin","type":"endpoint","title":"/signin"}

post/signin

Retrieve an access token. Use the access_token as part of the Authorization header.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

email:
required
string
Email address of user
password:
required
string
Password of user

Examples


Result Format


Documentation

The activation token is valid for 30 days.

User Information

Try It Out

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