Check Access

This endpoint checks the given access expression.

GET /check/{access_expression}

Check Access

cURL

curl --request GET \
  --url https://access.api.whop.com/check/{access_expression} \
  --header 'Authorization: Bearer <token>'

200

{
  "access": true
}

---

Usage

This endpoint is used to check if the current user has access to a given access expression. It is used in the hasAccess function of the SDK. You can find more information about access expressions in the Expressions section.

Authorizations

Authorization · string · header · required

The users access token, this can be fetched from the whop_user_token cookie.

Path Parameters

access_expression · string · required

The access expression to be checked.

Response

200 - application/json

Successful response

access · boolean