Scopes - Raba7ni Developer API

Info: When creating an API key, you must select the appropriate scopes to limit the key's access to only the necessary features.

List Available Scopes

GET List Scopes

public

/api/v1/reference/scopes

Retrieve the list of all available API scopes.

Response

{
  "success": true,
  "data": {
    "scopes": [
      "member_read",
      "member_write",
      "card_read",
      "points_read",
      "points_write",
      "..."
    ]
  }
}

Scopes Reference

Scope	Description	Product
`member_read`	Read access to members	Shared
`member_write`	Write access to members (create/update)	Shared
`card_read`	Read access to cards	Shared
`claim_read`	Read access to claim requests	Shared
`claim_write`	Write access to claim requests (create/approve/reject)	Shared
`referral_read`	Read access to referral data	Loyalty
`referral_write`	Write access to referrals (apply referrals)	Loyalty
`points_read`	Read points balance and history	Loyalty
`points_write`	Add and redeem points	Loyalty
`stamps_read`	Read stamp balance and history	Loyalty
`stamps_write`	Add and redeem stamps	Loyalty
`cashback_read`	Read cashback balance and history	Cashback
`cashback_write`	Earn and redeem cashback	Cashback
`coins_read`	Read coin wallet and transactions	Coins
`coins_write`	Issue and spend coins	Coins
`coins_referral_read`	Read coin referral settings and history	Loyalty
`coins_referral_write`	Apply coin referrals	Loyalty

API Scopes

List Available Scopes

Scopes Reference