Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Auth

Issue short-lived access tokens for scoped API access

Issue access token
client.auth.issueAccessToken(AuthIssueAccessTokenParams { grant_type, bound_entity } body, RequestOptionsoptions?): AuthIssueAccessTokenResponse { access_token, expires_in, token_type, bound_entity }
POST/v1/auth/access-tokens
ModelsExpand Collapse
Type = "employer" | "employee"
  • employer - employer
  • employee - employee
One of the following:
"employer"
"employee"
AuthIssueAccessTokenResponse { access_token, expires_in, token_type, bound_entity }
access_token: string

The issued access token (vit_at_*)

expires_in: number

Token lifetime in seconds

token_type: string

Token type, always ‘Bearer’

bound_entity?: BoundEntity | null

Entity the token is bound to, if any

id: string

Prefixed entity ID the token is bound to (empr_* or empl_*)

type: Type
  • employer - employer
  • employee - employee
One of the following:
"employer"
"employee"