Auth

Authenticate with API credentials and get an access token

Authentication with the GetAccept API can be made using JWT tokens (JSON Web Tokens) or the OAuth 2.0 Authorization Framework. All requests must be made via HTTPS, and all configuration URLs such as webhooks should begin with https:// as well.

Token based authentication is recommended for server-based access, or for access from clients where OAuth is not suitable. Access tokens are requested with a user's login credentials, and the token carries that user's role.

Requests should include the header Content-Type with the value application/json.

post/v1/auth

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/auth
  • Auth: none declared

Request body

emailstring required

The email of the user

passwordstring required

The password of the user

client_idstring

The client id of your app, if you received one from our API support

entity_idstring

Which entity to select when the user belongs to several. When omitted, the entity of the user's oldest active membership is used, skipping entities that are marked for deletion or quarantined.

user_idstring

Id of the user to authenticate, used together with the required email to select one specific user. It must be the id of a user with that email, otherwise the request fails like wrong credentials. Ignored when email itself carries the @user.id suffix, which takes precedence.

Response

The request succeeded.

access_tokenstring required

Access token to send as an Authorization Bearer header on every request.

expires_innumber required

Seconds until the access token expires.

Changes

No recorded changes to this operation across all 1 revision of this API.