GET
/
v1
/
organization
curl --request GET \
  --url https://public.api.collectpure.com/v1/organization \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "tradingEnabled": true,
  "payoutMethod": "<string>",
  "name": "<string>",
  "referredBy": "<string>",
  "points": 123,
  "redeemedPoints": 123,
  "tierName": "<string>",
  "tierPurchaseFee": 123,
  "tierSaleFee": 123
}

This endpoint returns detailed information about the organization associated with the provided API key.

​
Response Example

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2024-06-28 01:16:27.458387+00",
  "tradingEnabled": true,
  "payoutMethod": "teller_ach",
  "name": "Example Business",
  "referredBy": "Other Business",
  "points": 1841656,
  "redeemedPoints": 0,
  "tierName": "Plum",
  "tierPurchaseFee": 0.6666,
  "tierSaleFee": 0.6666
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Response

200
application/json
Default Response
​
id
string

Organization ID

​
createdAt
string

Creation timestamp

​
tradingEnabled
boolean

Whether trading is enabled for this organization

​
payoutMethod
string

Method used for payouts

​
name
string

Organization name

​
referredBy
string | null

Name of the organization that referred this organization

​
points
integer

Loyalty points earned

​
redeemedPoints
integer

Loyalty points redeemed

​
tierName
string | null

Current tier name

​
tierPurchaseFee
number | null

Fee percentage for purchases

​
tierSaleFee
number | null

Fee percentage for sales