Skip to main content
GET
Get an organization

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Response

200 - application/json
id
string<uuid>
required
read-only
name
string
required
Maximum string length: 255
slug
string
required
read-only
Pattern: ^[-a-zA-Z0-9_]+$
credit_balance
string<decimal>
required
read-only

Current credit balance (USD). Prepaid credits for scraping.

Pattern: ^-?\d{0,8}(?:\.\d{0,4})?$
low_balance_threshold
string<decimal>
required
read-only
Pattern: ^-?\d{0,8}(?:\.\d{0,4})?$
status
enum<string>
required
  • active - Active
  • suspended - Suspended
  • cancelled - Cancelled
Available options:
active,
suspended,
cancelled
is_over_limit
boolean
required
read-only

True once the credit balance is at or below zero.

member_count
integer
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
description
string