---
title: "Get the inbox logo (BIMI) of a sending domain"
method: GET
path: "/email-domains/{id}/bimi"
tags: ["Email"]
---

# Get the inbox logo (BIMI) of a sending domain

`GET /email-domains/{id}/bimi`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/email-domains/{id}/bimi`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `sites:read`)

Whether the domain can show its logo next to emails in the inbox (BIMI): the DMARC policy (it must be quarantine or reject for all mail), the BIMI record at default._bimi, and the steps that are left. Gmail shows the logo only with a mark certificate (VMC or CMC) that the user gets from a certificate authority; Apple Mail only with a VMC; Yahoo can show it without a certificate for domains with a good sending reputation, but that is not guaranteed. Read-only.

## Path parameters

- `id` string, uuid, required

## Response `200`

The logo settings of the domain.

- object
  - `email_domain_id` string, required
  - `domain` string, required
  - `dmarc` object, required
    - `record` string, nullable, required
    - `policy` 'none' | 'quarantine' | 'reject' | 'null', nullable, required
    - `percentage` number, required
    - `ok` boolean, required: quarantine or reject for all mail.
  - `bimi` object, required
    - `name` string, required
    - `record` string, nullable, required
    - `logo_url` string, nullable, required
    - `certificate_url` string, nullable, required
  - `ready` boolean, required
  - `dns_managed` boolean, required: The DNS is hosted here, so set_email_bimi sets the record itself.
  - `steps` string[], required
  - `note` string, required: Which mailboxes show the logo, and what they need.

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `404`: Not Found: not_found.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)