Body parameters

namestringrequired

The name of the domain to search for.

Response

objectstring

This will always contain list for this endpoint.

dataarray

An array of up to limit domain resources. If no domains are available, an empty array is returned.

metaobject

Additional information about the list.

import Blutui from 'blutui'

const blutui = new Blutui('ey....')

blutui.agency('studio').domains.search({
  name: 'example.com'
})
Response
{
  "object": "list",
  "data": [
    {
      "id": "9c17d680-e0af-4f00-9e28-08c4e38e89e0",
      "object": "domain",
      "name": "example.com",
      "token": "s0IWaAJ3IKIW2u8awxSJ6zgpXE8apYKougfefrkpkqO0sbLs55dqsWlz863ZR3hk",
      "project": "9c17d63b-96c0-4315-b4dd-e55373ce4ffd",
      "verified_at": 1711305486,
      "created_at": 1711305486,
      "updated_at": 1711305486
    },
    {...},
    {...}
  ],
  "meta": {
    "has_more": false,
    "current_page": 1,
    "from": 1,
    "to": 3,
    "total": 3,
    "per_page": 10,
    "last_page": 1
  }
}

Was this helpful?