Skip to main content
GET
/
api
/
v1
/
organization
Get organization
curl --request GET \
  --url https://api.bundle.social/api/v1/organization/ \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "createdById": "<string>",
  "apiAccess": true,
  "analyticsDisabled": true,
  "analyticsPostsDisabled": true,
  "uploadsCompressionEnabled": true,
  "showVerboseErrors": true,
  "disconnectCheckEnabled": true,
  "deleteAccountAfter": 12,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "id": "<string>",
    "externalId": "<string>",
    "email": "<string>",
    "role": "ADMIN",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "emailVerified": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "avatarUrl": "<string>",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "usage": {
    "monthlyPosts": 123
  },
  "teams": [
    {
      "id": "<string>",
      "name": "<string>",
      "organizationId": "<string>",
      "createdById": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "avatarUrl": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "promotionCodeId": "<string>",
  "name": "<string>",
  "avatarUrl": "<string>",
  "ref": "<string>",
  "dailyPostLimit": {
    "TWITTER": 123,
    "FACEBOOK": 123,
    "INSTAGRAM": 123,
    "LINKEDIN": 123,
    "YOUTUBE": 123,
    "TIKTOK": 123,
    "THREADS": 123,
    "PINTEREST": 123,
    "REDDIT": 123,
    "DISCORD": 123,
    "SLACK": 123,
    "MASTODON": 123,
    "BLUESKY": 123,
    "GOOGLE_BUSINESS": 123
  },
  "monthlyImportLimitPerAccount": 123,
  "analyticsInterval": 123,
  "analyticsPostsInterval": 123,
  "deletedAt": "2023-11-07T05:31:56Z",
  "subscription": {
    "id": "<string>",
    "organizationId": "<string>",
    "stripeSubscriptionId": "<string>",
    "status": "trialing",
    "stripePriceId": "<string>",
    "tier": "PRO",
    "cancelAtPeriodEnd": true,
    "created": "2023-11-07T05:31:56Z",
    "currentPeriodStart": "2023-11-07T05:31:56Z",
    "currentPeriodEnd": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "couponId": "<string>",
    "promotionCodeId": "<string>",
    "stripeSubscriptionItems": [
      {
        "id": "<string>",
        "price": "<string>",
        "quantity": 123
      }
    ],
    "metadata": {},
    "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,
    "maxMonthlyUploads": 123,
    "maxMonthlyImportedPosts": 123,
    "discountStart": "2023-11-07T05:31:56Z",
    "discountEnd": "2023-11-07T05:31:56Z",
    "coupon": {
      "id": "<string>",
      "duration": "forever",
      "valid": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "promotionCodes": [
        {
          "id": "<string>",
          "couponId": "<string>",
          "code": "<string>",
          "active": true,
          "firstTimeTransaction": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "expiresAt": "2023-11-07T05:31:56Z",
          "maxRedemptions": 123,
          "minimumAmount": 123
        }
      ],
      "name": "<string>",
      "amountOff": 123,
      "percentOff": 123,
      "durationInMonths": 123,
      "maxRedemptions": 123
    },
    "promotionCode": {
      "id": "<string>",
      "couponId": "<string>",
      "code": "<string>",
      "active": true,
      "firstTimeTransaction": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "coupon": {
        "id": "<string>",
        "duration": "forever",
        "valid": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "amountOff": 123,
        "percentOff": 123,
        "durationInMonths": 123,
        "maxRedemptions": 123
      },
      "expiresAt": "2023-11-07T05:31:56Z",
      "maxRedemptions": 123,
      "minimumAmount": 123
    }
  },
  "promotionCode": {
    "id": "<string>",
    "couponId": "<string>",
    "code": "<string>",
    "active": true,
    "firstTimeTransaction": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "coupon": {
      "id": "<string>",
      "duration": "forever",
      "valid": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "amountOff": 123,
      "percentOff": 123,
      "durationInMonths": 123,
      "maxRedemptions": 123
    },
    "expiresAt": "2023-11-07T05:31:56Z",
    "maxRedemptions": 123,
    "minimumAmount": 123
  }
}

Authorizations

x-api-key
string
header
required

Response

200

id
string
required
createdById
string
required
apiAccess
boolean
required
analyticsDisabled
boolean
required
analyticsPostsDisabled
boolean
required
uploadsCompressionEnabled
boolean
required
showVerboseErrors
boolean
required
disconnectCheckEnabled
boolean
required
deleteAccountAfter
integer
required
Required range: 0 <= x <= 24
createdAt
string<date-time> | null
required
updatedAt
string<date-time> | null
required
createdBy
object
required
usage
object
required
teams
object[]
required
promotionCodeId
string | null
name
string | null
avatarUrl
string | null
ref
string | null
dailyPostLimit
object
monthlyImportLimitPerAccount
number | null
analyticsInterval
number | null
analyticsPostsInterval
number | null
deletedAt
string<date-time> | null
subscription
object
promotionCode
object