Skip to main content
GET
/
organization
Retrieve organization details
curl --request GET \
  --url https://api.getfernand.com/organization \
  --header 'X-API-Key: <api-key>'
{
  "name": "PiedPiper Inc.",
  "slug": "piedpier",
  "from_name": "${agent_name} from ${organization_name}",
  "trial_ends_at": "2024-12-31T23:59:59Z",
  "trial_ends_at_ts": 1735689599000,
  "is_premium": true,
  "integrations": [
    "LINEAR",
    "SLACK"
  ],
  "created": "2024-01-01T00:00:00Z",
  "created_ts": 1704067200000,
  "is_custom_data_enabled": false,
  "is_ai_enabled": true,
  "is_ai_chat_enabled": true,
  "is_ai_articles_enabled": false,
  "is_ai_messages_enabled": false,
  "line1": "5230 Newell Road",
  "line2": "<string>",
  "zipcode": 94303,
  "city": "Palo Alto",
  "state": "California",
  "country": "US",
  "company_vat": "<string>",
  "billing_email": "billing@piedpiper.com",
  "notification_email": "notifications@piedpiper.com",
  "onboarding": {
    "email": "done",
    "channel": "done",
    "stripe": "ignored"
  },
  "renew_date": "2024-12-01T00:00:00Z",
  "renew_date_ts": 1733011200000,
  "cancels_at": "2024-12-31T23:59:59Z",
  "cancels_at_ts": 1735689599000,
  "card_expiry": "2025-12-01T00:00:00Z",
  "card_expiry_ts": 1764547200000,
  "card_brand": "Visa",
  "last4": "4242",
  "hours": {
    "monday": [
      {
        "open": "09:00",
        "close": "17:00"
      }
    ],
    "tuesday": [
      {
        "open": "09:00",
        "close": "17:00"
      }
    ]
  }
}
Returns the complete organization object.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Response

200 - application/json

Organization details retrieved successfully.

​
name
string
required

Name of the organization

Maximum string length: 250
Example:

"PiedPiper Inc."

​
slug
string
required

URL-friendly slug for the organization

Maximum string length: 250
Example:

"piedpier"

​
from_name
string
required

Template for the "From" name in emails. Supports variables like ${agent_name}, ${organization_name}, ${channel_email}

Maximum string length: 100
Example:

"${agent_name} from ${organization_name}"

​
trial_ends_at
string<date-time>
required

Timestamp when the trial period ends (UTC)

Example:

"2024-12-31T23:59:59Z"

​
trial_ends_at_ts
integer<int64>
required

Unix timestamp in milliseconds when the trial period ends

Example:

1735689599000

​
is_premium
boolean
required

Whether the organization has an active paid subscription

Example:

true

​
integrations
string[]
required

List of enabled integrations (e.g., LINEAR, GITHUB, SLACK)

Example:
["LINEAR", "SLACK"]
​
created
string<date-time>
required

Timestamp when the organization was created (UTC)

Example:

"2024-01-01T00:00:00Z"

​
created_ts
integer<int64>
required

Unix timestamp in milliseconds when the organization was created

Example:

1704067200000

​
is_custom_data_enabled
boolean
required

Whether the custom data panel is enabled and properly configured

Example:

false

​
is_ai_enabled
boolean
required

Whether AI features are enabled.

Example:

true

​
is_ai_chat_enabled
boolean
required

Whether AI chat feature is enabled

Example:

true

​
is_ai_articles_enabled
boolean
required

Whether AI articles feature is enabled

Example:

false

​
is_ai_messages_enabled
boolean
required

Whether AI messages feature is enabled

Example:

false

​
line1
string | null

First line of the organization's address

Maximum string length: 250
Example:

"5230 Newell Road"

​
line2
string | null

Second line of the organization's address (suite, building, etc.)

Maximum string length: 250
​
zipcode
string | null

Postal/ZIP code

Maximum string length: 25
Example:

94303

​
city
string | null

City name

Maximum string length: 250
Example:

"Palo Alto"

​
state
string | null

State or province

Maximum string length: 250
Example:

"California"

​
country
string | null

ISO 3166-1 alpha-2 country code

Maximum string length: 2
Example:

"US"

​
company_vat
string | null

VAT/Tax identification number

Maximum string length: 250
​
billing_email
string<email> | null

Email address for billing notifications

Example:

"billing@piedpiper.com"

​
notification_email
string<email> | null

Email address for system notifications

Example:

"notifications@piedpiper.com"

​
onboarding
object

Onboarding progress tracking with steps (email, channel, stripe, invite, snippet, rule, cheatsheet, knowledge) and their states (done, ignored)

Example:
{
  "email": "done",
  "channel": "done",
  "stripe": "ignored"
}
​
renew_date
string<date-time> | null

Next subscription renewal date (UTC)

Example:

"2024-12-01T00:00:00Z"

​
renew_date_ts
integer<int64> | null

Unix timestamp in milliseconds for next subscription renewal

Example:

1733011200000

​
cancels_at
string<date-time> | null

Timestamp when the subscription will be canceled (UTC)

Example:

"2024-12-31T23:59:59Z"

​
cancels_at_ts
integer<int64> | null

Unix timestamp in milliseconds when the subscription will be canceled

Example:

1735689599000

​
card_expiry
string<date-time> | null

Payment card expiration date (UTC)

Example:

"2025-12-01T00:00:00Z"

​
card_expiry_ts
integer<int64> | null

Unix timestamp in milliseconds for payment card expiration

Example:

1764547200000

​
card_brand
string | null

Payment card brand (Visa, Mastercard, etc.)

Maximum string length: 50
Example:

"Visa"

​
last4
string | null

Last 4 digits of the payment card

Maximum string length: 4
Example:

"4242"

​
hours
object

Business hours configuration with days and opening/closing times

Example:
{
  "monday": [{ "open": "09:00", "close": "17:00" }],
  "tuesday": [{ "open": "09:00", "close": "17:00" }]
}