Organization API

The organization, its settings, its usage against plan quotas and its activity log.

Operation	Method and path
Get organization	GET `/api/v1/organization`
Get organization posts usage	GET `/api/v1/organization/usage/posts`
Get organization comments usage	GET `/api/v1/organization/usage/comments`
Get organization uploads usage	GET `/api/v1/organization/usage/uploads`
Get daily limits usage for one social account on a given day	GET `/api/v1/organization/usage/daily-limits`
Get organization imports usage per social account (paginated)	GET `/api/v1/organization/usage/imports`
Create another organization	POST `/api/v1/organization/create`
Update organization settings	PATCH `/api/v1/organization/settings`
Delete the organization	POST `/api/v1/organization/delete`
Organization activity log	GET `/api/v1/organization/audit-log`

GET /api/v1/organization

Get organization

organization.getOrganization · requires x-api-key

Example

curl -X GET "https://api.siaran.my/api/v1/organization/" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

32 top-level fields

id string required
createdById string required
promotionCodeId string nullable
name string nullable
avatarUrl string nullable
ref string nullable
dailyPostLimit object nullable
15 fields
- TWITTER number
- FACEBOOK number
- INSTAGRAM number
- LINKEDIN number
- YOUTUBE number
- TIKTOK number
- THREADS number
- PINTEREST number
- REDDIT number
- DISCORD number
- SLACK number
- MASTODON number
- BLUESKY number
- GOOGLE_BUSINESS number
- SNAPCHAT number
dailyCommentLimit object nullable
15 fields
- TWITTER number
- FACEBOOK number
- INSTAGRAM number
- LINKEDIN number
- YOUTUBE number
- TIKTOK number
- THREADS number
- PINTEREST number
- REDDIT number
- DISCORD number
- SLACK number
- MASTODON number
- BLUESKY number
- GOOGLE_BUSINESS number
- SNAPCHAT number
monthlyImportLimitPerAccount number nullable
commentImportLimitPerPost number nullable
monthlyReviewImportLimitPerAccount number nullable
monthlyMessageLimitPerAccount number nullable
monthlyAutomationExecutionLimitPerAccount number nullable
apiAccess boolean required
analyticsDisabled boolean required
analyticsPostsDisabled boolean required
uploadsCompressionEnabled boolean required
analyticsInterval number nullable
analyticsPostsInterval number nullable
forcedAccountAnalyticsDailyLimit number nullable
forcedPostAnalyticsDailyLimit number nullable
showVerboseErrors boolean required
disconnectCheckEnabled boolean required
deleteAccountAfter integer required ≥ 0≤ 168
createdAt string required nullable date-time
updatedAt string required nullable date-time
deletedAt string nullable date-time
suspended boolean
createdBy object required
12 fields
- id string required
- externalId string required
- email string required
- emailVerified string nullable date-time
- firstName string nullable
- lastName string nullable
- avatarUrl string nullable
- timezone string nullable
- role string required
  
  One of: ADMIN CUSTOMER
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time
subscription object nullable
39 fields
- id string required
- organizationId string required
- couponId string nullable
- promotionCodeId string nullable
- stripeSubscriptionId string required
- stripeSubscriptionItems object[] nullable
  3 fields
  - id string required
  - price string required
  - quantity number required
- status string required
  
  One of: trialing active canceled incomplete incomplete_expired past_due unpaid paused
- metadata object nullable
- stripePriceId string required
- tier string required
  
  One of: PRO BUSINESS
- billingInterval string required
  
  One of: MONTHLY YEARLY
- isCustomPrice boolean required
- customPriceLabel string nullable
- customUnitAmount integer nullable
- customCurrency string nullable
- cancelAtPeriodEnd boolean required
- created string required nullable date-time
- currentPeriodStart string required nullable date-time
- currentPeriodEnd string required nullable date-time
- endedAt string nullable date-time
- cancelAt string nullable date-time
- canceledAt string nullable date-time
- trialStart string nullable date-time
- trialEnd string nullable date-time
- maxMonthlyPosts number nullable
- maxMonthlyComments number nullable
- maxMonthlyUploads number nullable
- maxMonthlyImportedPosts number nullable
- pendingTier string nullable
  
  One of: PRO BUSINESS
- pendingBillingInterval string nullable
  
  One of: MONTHLY YEARLY
- pendingPriceId string nullable
- pendingEffectiveAt string nullable date-time
- pendingScheduleId string nullable
- discountStart string nullable date-time
- discountEnd string nullable date-time
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- coupon object nullable
  10 fields
  - id string required
  - name string nullable
  - amountOff number nullable
  - percentOff number nullable
  - duration string required
    
    One of: forever once repeating
  - durationInMonths number nullable
  - maxRedemptions number nullable
  - valid boolean required
  - createdAt string required nullable date-time
  - updatedAt string required nullable date-time
- promotionCode object nullable
  2 fields
  - code string required
  - coupon object required
    
    4 fields
    
    percentOff number required
    
    duration string required
    
    One of: forever once repeating
    
    durationInMonths number nullable
    
    valid boolean required
promotionCode object nullable
2 fields
- code string required
- coupon object required
  4 fields
  - percentOff number required
  - duration string required
    
    One of: forever once repeating
  - durationInMonths number nullable
  - valid boolean required
teams object[] required
8 fields
- id string required
- name string required
- avatarUrl string nullable
- organizationId string required
- createdById string required
- createdAt string required nullable date-time
- updatedAt string required nullable date-time
- deletedAt string nullable date-time

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

GET /api/v1/organization/usage/posts

Get organization posts usage

organization.getPostsUsage · requires x-api-key

Example

curl -X GET "https://api.siaran.my/api/v1/organization/usage/posts" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

3 top-level fields

used number required
limit number required
remaining number required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

GET /api/v1/organization/usage/comments

Get organization comments usage

organization.getCommentsUsage · requires x-api-key

Example

curl -X GET "https://api.siaran.my/api/v1/organization/usage/comments" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

3 top-level fields

used number required
limit number required
remaining number required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

GET /api/v1/organization/usage/uploads

Get organization uploads usage

organization.getUploadsUsage · requires x-api-key

Example

curl -X GET "https://api.siaran.my/api/v1/organization/usage/uploads" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

3 top-level fields

used number required
limit number required
remaining number required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

GET /api/v1/organization/usage/daily-limits

Get daily limits usage for one social account on a given day

organization.getDailyLimitsUsage · requires x-api-key

Parameters

Name	In	Type	Notes
`socialAccountId` required	query	`string`
`date`	query	`string`	nullable

Example

curl -X GET "https://api.siaran.my/api/v1/organization/usage/daily-limits?socialAccountId=SOCIALACCOUNT_ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

5 top-level fields

date string required
socialAccountId string required
type string required

One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
posts object required
3 fields
- used number required
- limit number required
- remaining number required
comments object required
3 fields
- used number required
- limit number required
- remaining number required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

GET /api/v1/organization/usage/imports

Get organization imports usage per social account (paginated)

organization.getImportsUsage · requires x-api-key

Parameters

Name	In	Type	Notes
`page`	query	`number`	default 1
`pageSize`	query	`number`	default 20
`teamId`	query	`string`
`socialAccountType`	query	`string`	One of TIKTOK, YOUTUBE, INSTAGRAM, FACEBOOK, TWITTER, THREADS, LINKEDIN, PINTEREST, REDDIT, MASTODON, DISCORD, SLACK, BLUESKY, GOOGLE_BUSINESS, SNAPCHAT
`socialAccountId`	query	`string`

Example

curl -X GET "https://api.siaran.my/api/v1/organization/usage/imports" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

3 top-level fields

limitPerSocialAccount number required
socialAccounts object[] required
7 fields
- id string required
- type string required
- username string required nullable
- displayName string required nullable
- used number required
- limit number required
- remaining number required
pagination object required
4 fields
- page number required
- pageSize number required
- total number required
- totalPages number required

Errors: 400 Validation failed · 401 Missing or invalid API key · 403 Plan limit or permission · 404 Not found · 429 Rate limited · 500 Server error · 502 Network error

POST /api/v1/organization/create

Create another organization

organization.create · requires x-api-key

Request body `application/json`

name string required

Example

curl -X POST "https://api.siaran.my/api/v1/organization/create" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "name": "Example"
  }'

Response `201`

4 top-level fields

id string required
organizationId string required
organizationName string
role string required

One of: OWNER ADMIN MEMBER

PATCH /api/v1/organization/settings

Update organization settings

organization.updateSettings · requires x-api-key

Request body `application/json`

name string
uploadsCompression boolean
verboseErrors boolean
remoteDisconnectChecks boolean
deleteDisconnectedAfterHours integer ≥ 0≤ 168
portalBrandName string nullable
portalLogoUrl string nullable
portalAccentColor string nullable

Example

curl -X PATCH "https://api.siaran.my/api/v1/organization/settings" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "name": "Example",
    "uploadsCompression": false,
    "verboseErrors": false
  }'

Response `200`

A map<string, any>.

POST /api/v1/organization/delete

Delete the organization

organization.delete · requires x-api-key

Request body `application/json`

confirmName string required

Example

curl -X POST "https://api.siaran.my/api/v1/organization/delete" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "confirmName": "Example"
  }'

Response `200`

1 top-level fields

success boolean required

GET /api/v1/organization/audit-log

Organization activity log

organization.auditLog · requires x-api-key

Parameters

Name	In	Type	Notes
`offset`	query	`integer`
`limit`	query	`integer`

Example

curl -X GET "https://api.siaran.my/api/v1/organization/audit-log" \
  -H "x-api-key: $SIAR_API_KEY"

Response `200`

2 top-level fields

items object[] required
8 fields
- id string required
- actorType string
- actorName string
- action string
- entity string
- entityId string nullable
- summary string required
- createdAt string date-time
total integer required

Organization API

Example

Response 200

Example

Response 200

Example

Response 200

Example

Response 200

Parameters

Example

Response 200

Parameters

Example

Response 200

Request body application/json

Example

Response 201

Request body application/json

Example

Response 200

Request body application/json

Example

Response 200

Parameters

Example

Response 200

Response `200`

Response `200`

Response `200`

Response `200`

Response `200`

Response `200`

Request body `application/json`

Response `201`

Request body `application/json`

Response `200`

Request body `application/json`

Response `200`

Response `200`