Refresh Access Token

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

🚧

This endpoint is deprecated

Please use the Get Access Token v2 endpoint for exchanging a refresh token with an access token.

Request Headers

Content-Type: application/x-www-form-urlencoded

Response

Parameter NameDescription
access_tokenToken issued by the authorization server. The token will be 128 characters long. Tokens will be valid for the R2R api for 7 days.
expires_inSeconds until token expires.
expiration_timestampThe expiration time of the access token in ISO8601 format.
token_typeThe type of token issued. Default to ā€˜Bearer’

Error Scenarios

For the following error scenarios, Yelp will respond with an HTTP error with the following format for the response body:

{
    "error": {
        "id" : "<ERROR_CODE_ID>",
        "description": "<Human readable description.>",
        "http_code": "<http_code>"
    }
}
iddescriptionhttp_code
INVALID_REQUESTMissing a required parameter or includes an unsupported parameter.HTTPBadRequest (400)
CLIENT_NOT_FOUNDSupplied client ID does not exist.HTTPNotFound (404)
INVALID_CLIENTClient authentication failed due to unknown client, no client authentication included, or unsupported authentication method.HTTPUnauthorized (401)
UNAUTHORIZED_CLIENTThe authenticated client is not authorized to use this authorization grant type.HTTPBadRequest (400)
UNSUPPORTED_GRANT_TYPEThe authorization grant type is not supported by the authorization server.HTTPBadRequest (400)
TOKEN_NOT_FOUNDSupplied refresh token does not exist.HTTPNotFound (404)
INVALID_SCOPEThe request is unauthorized for the given scope.HTTPBadRequest (400)
INVALID_TOKENThe access token linked to this refresh token is expired, revoked, malformed, or invalid for other reasons.HTTPBadRequest (400)
Body Params
string

Required. ID assigned by Yelp for the third-party system that will make user-authorized requests to Yelp.

string

Required. Client secret assigned by Yelp for the third-party system that will make user-authorized requests to Yelp.

string

Required. The grant being presented in order to exchange for an access token. For example, when refreshing an access token, this value will be ā€œrefresh_tokenā€.

string

Required. Token used for refresh issued by the authorization server along with access token. The token will be 128 characters long.

string

Optional. An string action that the business user is authorizing the client to perform. In the case of R2R, this value will be ā€œr2rā€.

Response

Language
LoadingLoading…
Response
Choose an example:
application/json