GET
/
api
/
v1
/
organization
curl --request GET \
  --url https://api.bundle.social/api/v1/organization/ \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "createdById": "<string>",
  "promotionCodeId": "<string>",
  "name": "<string>",
  "avatarUrl": "<string>",
  "apiAccess": true,
  "ref": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "teams": [
    {
      "id": "<string>",
      "name": "<string>",
      "avatarUrl": "<string>",
      "organizationId": "<string>",
      "createdById": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdBy": {
    "id": "<string>",
    "externalId": "<string>",
    "email": "<string>",
    "emailVerified": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "avatarUrl": "<string>",
    "role": "ADMIN",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "subscription": {
    "id": "<string>",
    "organizationId": "<string>",
    "couponId": "<string>",
    "promotionCodeId": "<string>",
    "stripeSubscriptionId": "<string>",
    "stripeSubscriptionItems": [
      {
        "id": "<string>",
        "price": "<string>",
        "quantity": 123
      }
    ],
    "status": "trialing",
    "metadata": {},
    "stripePriceId": "<string>",
    "tier": "PRO",
    "cancelAtPeriodEnd": true,
    "created": "2023-11-07T05:31:56Z",
    "currentPeriodStart": "2023-11-07T05:31:56Z",
    "currentPeriodEnd": "2023-11-07T05:31:56Z",
    "endedAt": "2023-11-07T05:31:56Z",
    "cancelAt": "2023-11-07T05:31:56Z",
    "canceledAt": "2023-11-07T05:31:56Z",
    "trialStart": "2023-11-07T05:31:56Z",
    "trialEnd": "2023-11-07T05:31:56Z",
    "maxMonthlyPosts": 123,
    "discountStart": "2023-11-07T05:31:56Z",
    "discountEnd": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "coupon": {
      "id": "<string>",
      "name": "<string>",
      "amountOff": 123,
      "percentOff": 123,
      "duration": "forever",
      "durationInMonths": 123,
      "maxRedemptions": 123,
      "valid": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "promotionCodes": [
        {
          "id": "<string>",
          "couponId": "<string>",
          "code": "<string>",
          "active": true,
          "expiresAt": "2023-11-07T05:31:56Z",
          "maxRedemptions": 123,
          "firstTimeTransaction": true,
          "minimumAmount": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    },
    "promotionCode": {
      "id": "<string>",
      "couponId": "<string>",
      "code": "<string>",
      "active": true,
      "expiresAt": "2023-11-07T05:31:56Z",
      "maxRedemptions": 123,
      "firstTimeTransaction": true,
      "minimumAmount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "coupon": {
        "id": "<string>",
        "name": "<string>",
        "amountOff": 123,
        "percentOff": 123,
        "duration": "forever",
        "durationInMonths": 123,
        "maxRedemptions": 123,
        "valid": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    }
  },
  "promotionCode": {
    "id": "<string>",
    "couponId": "<string>",
    "code": "<string>",
    "active": true,
    "expiresAt": "2023-11-07T05:31:56Z",
    "maxRedemptions": 123,
    "firstTimeTransaction": true,
    "minimumAmount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "coupon": {
      "id": "<string>",
      "name": "<string>",
      "amountOff": 123,
      "percentOff": 123,
      "duration": "forever",
      "durationInMonths": 123,
      "maxRedemptions": 123,
      "valid": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "usage": {
    "monthlyPosts": 123
  }
}

Authorizations

​
x-api-key
string
header
required

Response

200
application/json
200
​
id
string
required
​
createdById
string
required
​
createdAt
string | null
required
​
updatedAt
string | null
required
​
teams
object[]
required
​
createdBy
object
required
​
usage
object
required
​
promotionCodeId
string | null
​
name
string | null
​
avatarUrl
string | null
​
apiAccess
boolean
default:true
​
ref
string | null
​
deletedAt
string | null
​
subscription
object | null
​
promotionCode
object | null

Was this page helpful?

Suggest editsRaise issue