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

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 }}