Lumirank API docs
Brand

Get your brand

GET/v1/brand

Returns the brand that the API key belongs to: its name, domains, countries, engines, prompt counts, and the time of its newest answer. It also names the key that made the request.

Use it to check that a key works, and to read the ids that other requests take. competitor_id is the id of your own brand in /v1/mentions and in the brands report.

Authorization

apiKey
AuthorizationBearer <token>

An API key that you create in the Lumirank dashboard, on the Settings > API keys page. Send it in the Authorization header: Bearer lr_....

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/brand"

brand

{  "id": "6f1c2a0e-4b7d-4c1e-9a55-0d2b8f3c7e11",  "name": "Acme",  "aliases": [    "Acme Inc"  ],  "domains": [    "acme.com",    "acme.io"  ],  "include_subdomains": false,  "primary_country": "US",  "countries": [    "GB",    "US"  ],  "engines": [    {      "id": "chatgpt",      "name": "ChatGPT"    },    {      "id": "perplexity",      "name": "Perplexity"    }  ],  "prompt_counts": {    "active": 42,    "paused": 3,    "archived": 5  },  "data_through": "2026-10-08T06:41:12Z",  "created_at": "2026-07-02T10:15:00Z",  "competitor_id": "5e0b3f71-9a2c-4d8e-b6f4-2c1d0e9f8a73",  "api_key": {    "id": "0b9e4d2a-7c1f-4e3b-8a6d-5f2c1b0e9d84",    "name": "Looker sync",    "permission": "read"  }}