Obtain or refresh an access token

post

https://api.ads.roku.com/v1/developer/token

Get an access_token to make authenticated calls to the Ads API or get a refresh_token to request a new access_token once the current token expires. For initial authorization, send a code (authorization code) and get a refresh_token and an access_token. To refresh an access_token, send the refresh_token and get an access_token.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Contains API credentials to exchange for either an access_token or a refresh_token.

client_id

string

required

Your application's client identifier. Required when grant_type is authorization_code or refresh_token.

client_secret

string

required

Your application's client secret for authentication. Required when grant_type is authorization_code or refresh_token.

grant_type

string

enum

required

Denotes the flow you are using. For initial authorization to get an access_token use authorization_code. To refresh a token use refresh_token.

Allowed:

code

string

Authorization code. Required when grant_type is authorization_code.

redirect_uri

uri

Redirect URI used in the authorization request. Required when grant_type is authorization_code.

refresh_token

string

Refresh token. Required when grant_type is refresh_token.

Responses

200Success. For initial authorization, returns the created access_token along with a token_type value, expires_in value, and a refresh_token. For refreshing a token, returns an access_token along with a token_type value and an expires_in value.

401Unauthorized error

403Forbidden error

422Unprocessable entity error

500Internal server error