Get your organization

GET /api/ApiClient/getOrganization

Authentication

Send your private API key in the X-Api-Key header. Keep it on your server.

Request example

Examples use illustrative values. Set FERRETLY_API_KEY in your server environment for JavaScript, Python, and C#. Replace sample IDs, URLs, and profile values before use.

curl

curl --fail -sS -X GET "https://api.ferretly.com/api/ApiClient/getOrganization" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("https://api.ferretly.com/api/ApiClient/getOrganization", {
  "method": "GET",
  "headers": {
    "X-Api-Key": process.env.FERRETLY_API_KEY,
    "Accept": "application/json"
  }
});
if (!response.ok) throw new Error("HTTP " + response.status);
console.log(await response.json());

Python

import os
import requests

response = requests.request(
    "GET",
    "https://api.ferretly.com/api/ApiClient/getOrganization",
    headers={"X-Api-Key":os.environ["FERRETLY_API_KEY"],"Accept":"application/json"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

C#

using System;
using System.IO;
using System.Net.Http;
using System.Text;

using var http = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.ferretly.com/api/ApiClient/getOrganization");
request.Headers.Add("X-Api-Key", Environment.GetEnvironmentVariable("FERRETLY_API_KEY"));
request.Headers.Accept.ParseAdd("application/json");
using var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Responses

200

Success

• text/plain: Organization
• application/json: Organization
• text/json: Organization

Response example

Illustrative, shortened HTTP 200 response. Optional fields can be absent or null.

{
  "id": "22222222-2222-4222-8222-222222222222",
  "name": "Example Organization",
  "purchasedAnalystSupport": false,
  "credits_available": 10
}

Response properties

Property	Type	Description
id	string (uuid)
name	string	Nullable.
purchasedAnalystSupport	boolean	Read-only response field.
affiliate_guid	string (uuid)	Nullable.
affiliate	AffiliateInfo
credits_available	integer (int32)
credits_used	integer (int32)
stripe_customerId	string	Nullable.
socialMediaScraperYears	integer (int32)
planType	PlanType
paymentMethod	PaymentMethod
isSubscriptionActive	boolean
stripeSubscriptionId	string	Nullable.
stripePlanId	string	Nullable.
stripePricingId	string	Nullable.
numberOfContinuousScreeningSubjectsEnabled	integer (int64)	The number of subjects for which continuous screening is enabled
piplCreditsAvailable	integer (int32)
piplCreditsUsed	integer (int32)
alternateDisclaimerText	string	Text to use as an alternate disclaimer page Nullable.
data_retention_years	integer (int32)	Number of years used for data retention
data_retention_period	DataRetentionPeriod
instructions	string	Gets or sets the instructions for the organization Nullable.
pricingModel	PricingModel
isReseller	boolean	Gets or sets whether the organization is a reseller. This flag distinguishes resellers from standard organizations in the system.
allowNegativeCredits	boolean	When true, the organization is permitted to carry a negative credit balance. Charging flows will not reject requests when credits are at or below zero.

affiliate properties

Property	Type	Description
_id	string (uuid)
_owner	string (uuid)
email	string	Nullable.
status	string	Nullable.
_createdDate	string (date-time)
_updatedDate	string (date-time)
companyName	string	Nullable.
websiteAddress	string	Nullable.
whitelabel	boolean
logo	string	Nullable.
companyAddress	string	Nullable.
companyAddress2	string	Nullable.
companyCity	string	Nullable.
companyPostalCode	string	Nullable.
companyState	string	Nullable.

Related guides

• Authentication
• With Analyst Assistance
• Without Analyst Assistance
• Errors and status codes