COcontext
Brand Intelligence

Retrieve brand data by email address

Changed on

Retrieve brand information using an email address while detecting disposable and free email addresses. Disposable and free email addresses (like gmail.com, yahoo.com) will throw a 422 error.

get/brand/retrieve-by-email

Request

  • Base URL
    https://api.context.dev/v1
  • URL
    https://api.context.dev/v1/brand/retrieve-by-email
  • Auth
    HTTP bearer

Query parameters

emailstring email required

Email address to retrieve brand data for (e.g., 'contact@example.com'). The domain will be extracted from the email. Free email providers (gmail.com, yahoo.com, etc.) and disposable email addresses are not allowed.

force_language'afrikaans' | 'albanian' | 'amharic' | 'arabic' | 'armenian' | 'assamese' | 'aymara' | 'azeri' | 'basque' | 'belarusian' | 'bengali' | 'bosnian' | 'bulgarian' | 'burmese' | 'cantonese' | 'catalan' | 'cebuano' | 'chinese' | 'corsican' | 'croatian' | 'czech' | 'danish' | 'dutch' | 'english' | 'esperanto' | 'estonian' | 'farsi' | 'fijian' | 'finnish' | 'french' | 'galician' | 'georgian' | 'german' | 'greek' | 'guarani' | 'gujarati' | 'haitian-creole' | 'hausa' | 'hawaiian' | 'hebrew' | 'hindi' | 'hmong' | 'hungarian' | 'icelandic' | 'igbo' | 'indonesian' | 'irish' | 'italian' | 'japanese' | 'javanese' | 'kannada' | 'kazakh' | 'khmer' | 'kinyarwanda' | 'korean' | 'kurdish' | 'kyrgyz' | 'lao' | 'latin' | 'latvian' | 'lingala' | 'lithuanian' | 'luxembourgish' | 'macedonian' | 'malagasy' | 'malay' | 'malayalam' | 'maltese' | 'maori' | 'marathi' | 'mongolian' | 'nepali' | 'norwegian' | 'odia' | 'oromo' | 'pashto' | 'pidgin' | 'polish' | 'portuguese' | 'punjabi' | 'quechua' | 'romanian' | 'russian' | 'samoan' | 'scottish-gaelic' | 'serbian' | 'sesotho' | 'shona' | 'sindhi' | 'sinhala' | 'slovak' | 'slovene' | 'somali' | 'spanish' | 'sundanese' | 'swahili' | 'swedish' | 'tagalog' | 'tajik' | 'tamil' | 'tatar' | 'telugu' | 'thai' | 'tibetan' | 'tigrinya' | 'tongan' | 'tswana' | 'turkish' | 'turkmen' | 'ukrainian' | 'urdu' | 'uyghur' | 'uzbek' | 'vietnamese' | 'welsh' | 'wolof' | 'xhosa' | 'yiddish' | 'yoruba' | 'zulu' nullable

Language to force for the retrieved brand data.

maxSpeedboolean

Optional parameter to optimize the API call for maximum speed. When set to true, the API will skip time-consuming operations for faster response at the cost of less comprehensive data.

maxAgeMsinteger nullable

Maximum age in milliseconds for cached brand data before the API performs a hard refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms) are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1 year.

timeoutMSinteger

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Optional comma-separated caller-defined tags for tracking this request. Tags are recorded on the request's usage log and can be used to filter usage on the dashboard usage page. Up to 20 tags, each 1-50 characters.

[
  "production",
  "team-alpha"
]

Response

Successful response

statusstring

Status of the response, e.g., 'ok'

codeinteger

HTTP status code

Changes