Skip to Content

Check your key

Any valid key may make this call.

Which company and scopes this key has, and when it expires. Works with any valid key: use it to check that your key works.

Response Body

OK

application/json
  1. response
client*

The company the key belongs to.

keyPrefix*string

The first 12 characters of the key, safe to log.

scopes*array<>
expiresAt?|

When the key stops working, or null. From slice S2.

Example Request
curl -sS https://platform.charpstar.co/api/v1/me \  -H "Authorization: Bearer $CHARPSTAR_API_KEY"
Example Response
{  "client": {    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",    "name": "Your Company"  },  "keyPrefix": "cs_live_Ab3d",  "scopes": [    "products:read",    "products:write",    "reviews:write",    "assets:read",    "webhooks:manage",    "account:read"  ]}