Path parameters

idstringrequired

The ID of the agency to retrieve.

Response

idstring

The unique identifier for this agency.

objectstring

This will always contain agency for this endpoint.

namestring

The agency name.

emailstring

The agency's preferred email address.

slugstring

The agency's unique username.

urlstring | null

The agency's website URL.

locationstring

The ISO 3166 country code for the agency's location.

timezonestring

The agency's preferred timezone.

avatarstring | null

The asset URL for the agency's avatar.

descriptionstring | null

A short description about the agency.

trial_modeboolean

Determine whether the agency is subscribed to Blutui.

is_agencyboolean

Determine whether the agency is a qualified Blutui agency.

is_aws_customerboolean

Determine whether the agency is an AWS marketplace customer.

created_attimestamp

The agency's created at timestamp.

updated_attimestamp

The agency's updated at timestamp.

import Blutui from 'blutui'

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

blutui.agencies.get('9af3accc-1536-4336-8cc3-3b3b2a96c18a')
Response
{
  "id": "9af3accc-1536-4336-8cc3-3b3b2a96c18a",
  "object": "agency",
  "name": "Flume",
  "email": "jayan@flume.agency",
  "slug": "flume",
  "url": "https://flume.agency",
  "location": "NZ",
  "timezone": "UTC",
  "avatar": null,
  "description": null,
  "trial_mode": false,
  "is_agency": false,
  "is_aws_customer": false,
  "created_at": 1703713667,
  "updated_at": 1721087098
}

Was this helpful?