DocsAPIBrand and key

Brand and key

Retrieve the brand an API key belongs to and the key's scopes and expiry. The first call to make with a new key, and the cheapest health check.

ReferenceUpdated Oct 8, 20261 min read

Every key belongs to exactly one brand, and /me tells you which. Use it to confirm a new key works, to check which scopes a deployed key carries, or as the health check your integration runs before a sync.

Retrieve the current brand and key#

GET/api/brand/v1/me

Returns the brand the key belongs to and the key’s own metadata. Needs no scope, so it is the call to make first: if it answers 200, the key works.

Scopenone

Parameters

No parameters.

Returns

The brand and the key that authenticated the request.

brandobject
The brand the key belongs to. Every request with this key reads this brand’s data and no other.
- idstring
  The brand’s Rendezvu id (UUID).
- namestring
  The brand name.
keyobject
The key that made the request. Never the secret.
- idstring
  The key’s id, as listed in the console.
- scopesarray of strings
  The scopes this key carries.
- expires_attimestamp
  When the key stops working.

curl 'https://api.rendezvu.co/api/brand/v1/me' \
  -H "Authorization: Bearer $RENDEZVU_BRAND_API_KEY"

Response

{
  "success": true,
  "data": {
    "brand": {
      "id": "3d9a7c1e-5b2f-4a8d-9e6c-1f0b2a3c4d5e",
      "name": "Northfork Gear Co."
    },
    "key": {
      "id": "0f9e8d7c-6b5a-4c3d-9e2f-1a0b9c8d7e6f",
      "scopes": [
        "analytics:read",
        "content:read"
      ],
      "expires_at": "2027-01-06T17:42:10.000Z"
    }
  },
  "_timing": {
    "duration_ms": 42
  }
}

AuthenticationAuthenticate every request with a secret API key in the Authorization header. Keys are read-only, scoped, tied to one brand, and always expire.

Was this page helpful?