Listings your domain claims

GET

/api/v1/hub/offers

curl --request GET \
  --url http://localhost:3000/api/v1/hub/offers \
  --header 'Authorization: Bearer <token>'

Public BrandHub listings of other organizations whose domain one of your verified domains proves (the domain, a name under it or above it), whose own organization proved none of it, and that you haven’t refused. Organization admin.

Scope: admin.

Authorizations

• bearer
• session
• None

Responses

200

The offers

Media typeapplication/json

object

data

required

Array<object>

object

id

required

The listing’s brand

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

org

required

string

owner

required

Its organization’s name

string

brand

required

string

name

required

string

domain

required

The domain it names, which your organization proved

string

proof

required

Your verified domain that proves it

string

url

required

Its page on BrandHub

string

Example^generated

{
  "data": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "org": "example",
      "owner": "example",
      "brand": "example",
      "name": "example",
      "domain": "example",
      "proof": "example",
      "url": "example"
    }
  ]
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}