Skip to main content
GET
/
organization
Get organization details
curl --request GET \
  --url https://api.dnsradar.dev/organization \
  --header 'X-Api-Key: <api-key>'
{
  "id": "org_abc123...",
  "name": "Pied Piper",
  "line1": "5230 Newell Rd",
  "line2": "Suite 400",
  "zipcode": "94303",
  "city": "Palo Alto",
  "state": "CA",
  "country": "US",
  "company_vat": "<string>",
  "billing_email": "billing@piedpiper.com",
  "is_premium": true,
  "renew_date": "2023-11-07T05:31:56Z",
  "cancels_at": "2023-11-07T05:31:56Z",
  "card_expiry": "2023-11-07T05:31:56Z",
  "card_brand": "visa",
  "last4": "1234",
  "webhook_limit": 5,
  "max_api_keys": 10,
  "total_monitors": 150
}

Authorizations

​
X-Api-Key
string
header
required

API key used to authenticate yourself on DNSRadar. Obtain your API key from your DNSRadar dashboard.

Response

Organization details

Organization or workspace

​
id
string<string>

Organization UUID (32 characters)

Example:

"org_abc123..."

​
name
string

Organization name

Example:

"Pied Piper"

​
line1
string | null

Address line 1

Example:

"5230 Newell Rd"

​
line2
string | null

Address line 2

Example:

"Suite 400"

​
zipcode
string | null

Postal/ZIP code

Example:

"94303"

​
city
string | null

City

Example:

"Palo Alto"

​
state
string | null

State or province

Example:

"CA"

​
country
string | null

2-letter country code

Example:

"US"

​
company_vat
string | null

European VAT/Tax number

​
billing_email
string<email> | null

Billing contact email address

Example:

"billing@piedpiper.com"

​
is_premium
boolean

Whether organization has an active subscription

​
renew_date
string<date-time> | null

Next billing date

​
cancels_at
string<date-time> | null

Scheduled cancellation date

​
card_expiry
string<date-time> | null

Credit card expiry date

​
card_brand
string | null

Credit card brand (visa, mastercard, etc.)

Example:

"visa"

​
last4
string | null

Last 4 digits of credit card

Example:

"1234"

​
webhook_limit
integer
default:5

Maximum number of webhooks allowed for this organization. You can request an increase by contacting support.

Example:

5

​
max_api_keys
integer
default:10

Maximum number of API keys allowed for this organization. You can request an increase by contacting support.

Example:

10

​
total_monitors
integer

Total number of monitors in this organization

Example:

150