v1

latestSwagger 2.02026-07-13421625.7 KB
auth

Start an authentication request

If you want to access the TVmaze API on behalf of a user without querying them for their password, use this endpoint.

To get started, send a POST request containing the user's email address. The response will contain a token, which you can use as input to the poll endpoint. The user will receive an email prompting them to confirm the authentication request.

Alternatively, if you expect the user to be logged in to TVmaze on the device they are currently interacting with, you can set email_confirmation to false and redirect them to the confirm_url URL. If they are logged in to TVmaze, they will be able to confirm the authentication request instantly.

post/auth/start

Request body

emailstring

The user's email address

email_confirmationboolean

Whether to email the user a confirmation link

Response

The authentication request was succesfully started

tokenstring

Authentication token to use in the poll endpoint

confirm_urlstring

URL where the user can confirm the authentication request