Start free

Teams API

Teams (social sets) group at most one account per network. Create one team per customer, brand or location.

OperationMethod and path
Get teamGET /api/v1/team/{id}
Update teamPATCH /api/v1/team/{id}
Delete teamDELETE /api/v1/team/{id}
Get list of teamsGET /api/v1/team
Create new teamPOST /api/v1/team
GET /api/v1/team/{id}

Get team

team.getTeam · requires x-api-key

Parameters

NameInTypeNotes
id required path string

Example

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

Response 200

13 top-level 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
  • organization object required
    28 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
  • bots object[] required
    7 fields
    • id string required
    • name string required
    • avatarUrl string nullable
    • teamId string required
    • createdAt string required nullable date-time
    • updatedAt string required nullable date-time
    • deletedAt string nullable date-time
  • socialAccounts object[] required
    26 fields
    • id string required
    • type string required
      One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
    • teamId string required
    • username string nullable
    • displayName string nullable
    • bio string nullable
    • avatarUrl string nullable
    • externalId string nullable
    • providerPageId string nullable
    • userUsername string nullable
    • userDisplayName string nullable
    • userEmail string nullable
    • userId string nullable
    • channels object[] nullable
      7 fields
      • id string required
      • name string nullable
      • username string nullable
      • address string nullable
      • avatarUrl string nullable
      • webhook object nullable
        4 fields
        • id string nullable
        • name string nullable
        • avatar string nullable
        • url string nullable
      • metadata object nullable
        5 fields
        • allowImages boolean nullable
        • allowVideos boolean nullable
        • allowGalleries boolean nullable
        • linkFlairEnabled boolean nullable
        • facebookPageId string nullable
    • mastodonServerId string nullable
    • instagramConnectionMethod string nullable
      One of: FACEBOOK INSTAGRAM
    • twitterSubType string nullable
      One of: none basic premium premium_plus
    • isTiktokBusinessAccount boolean nullable
    • disconnectedCheckTryAt string nullable date-time
    • deleteOn string nullable date-time
    • messagingStatus string default "DISABLED"
      One of: DISABLED ENABLED DISABLE_PENDING
    • messagingStatusUpdatedAt string nullable date-time
    • messagingLastError string nullable
    • createdAt string required nullable date-time
    • updatedAt string required nullable date-time
    • deletedAt string nullable date-time
  • bio object nullable
    10 fields
    • id string required
    • username string required
    • name string required nullable
    • description string required nullable
    • avatarUrl string required nullable
    • socials map<string, string> required nullable
    • teamId string required
    • createdAt string required nullable date-time
    • updatedAt string required nullable date-time
    • items object[] required
      10 fields
      • id string required
      • bioId string required
      • name string required
      • link string required
      • icon string nullable
      • enabled boolean required
      • order number nullable
      • createdAt string required nullable date-time
      • updatedAt string required nullable date-time
      • analytics object[] required
        7 fields
        • id string required
        • count number required
        • bioItemId string required
        • deviceType map<string, number> required
        • country map<string, number> required
        • createdAt string required nullable date-time
        • updatedAt string required 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

PATCH /api/v1/team/{id}

Update team

team.updateTeam · requires x-api-key

Parameters

NameInTypeNotes
id required path string

Request body application/json

  • name string min length 3max length 80
  • avatarUrl string nullable

Example

curl -X PATCH "https://api.siaran.my/api/v1/team/ID" \
  -H "x-api-key: $SIAR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "name": "Example",
    "avatarUrl": "https://example.com/file.jpg"
  }'

Response 200

8 top-level 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

DELETE /api/v1/team/{id}

Delete team

team.deleteTeam · requires x-api-key

Parameters

NameInTypeNotes
id required path string

Example

curl -X DELETE "https://api.siaran.my/api/v1/team/ID" \
  -H "x-api-key: $SIAR_API_KEY"

Response 200

8 top-level 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/team

Get list of teams

team.getList · requires x-api-key

Parameters

NameInTypeNotes
offset query number default 0 · nullable
limit query number default 10 · nullable
search query string nullable

Example

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

Response 200

2 top-level fields
  • items object[] required
    13 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
    • organization object required
      28 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
    • bots object[] required
      7 fields
      • id string required
      • name string required
      • avatarUrl string nullable
      • teamId string required
      • createdAt string required nullable date-time
      • updatedAt string required nullable date-time
      • deletedAt string nullable date-time
    • socialAccounts object[] required
      26 fields
      • id string required
      • type string required
        One of: TIKTOK YOUTUBE INSTAGRAM FACEBOOK TWITTER THREADS LINKEDIN PINTEREST REDDIT MASTODON DISCORD SLACK BLUESKY GOOGLE_BUSINESS SNAPCHAT
      • teamId string required
      • username string nullable
      • displayName string nullable
      • bio string nullable
      • avatarUrl string nullable
      • externalId string nullable
      • providerPageId string nullable
      • userUsername string nullable
      • userDisplayName string nullable
      • userEmail string nullable
      • userId string nullable
      • channels object[] nullable
        7 fields
        • id string required
        • name string nullable
        • username string nullable
        • address string nullable
        • avatarUrl string nullable
        • webhook object nullable
          4 fields
          • id string nullable
          • name string nullable
          • avatar string nullable
          • url string nullable
        • metadata object nullable
          5 fields
          • allowImages boolean nullable
          • allowVideos boolean nullable
          • allowGalleries boolean nullable
          • linkFlairEnabled boolean nullable
          • facebookPageId string nullable
      • mastodonServerId string nullable
      • instagramConnectionMethod string nullable
        One of: FACEBOOK INSTAGRAM
      • twitterSubType string nullable
        One of: none basic premium premium_plus
      • isTiktokBusinessAccount boolean nullable
      • disconnectedCheckTryAt string nullable date-time
      • deleteOn string nullable date-time
      • messagingStatus string default "DISABLED"
        One of: DISABLED ENABLED DISABLE_PENDING
      • messagingStatusUpdatedAt string nullable date-time
      • messagingLastError string nullable
      • createdAt string required nullable date-time
      • updatedAt string required nullable date-time
      • deletedAt string nullable date-time
    • bio object nullable
      10 fields
      • id string required
      • username string required
      • name string required nullable
      • description string required nullable
      • avatarUrl string required nullable
      • socials map<string, string> required nullable
      • teamId string required
      • createdAt string required nullable date-time
      • updatedAt string required nullable date-time
      • items object[] required
        10 fields
        • id string required
        • bioId string required
        • name string required
        • link string required
        • icon string nullable
        • enabled boolean required
        • order number nullable
        • createdAt string required nullable date-time
        • updatedAt string required nullable date-time
        • analytics object[] required
          7 fields
          • id string required
          • count number required
          • bioItemId string required
          • deviceType map<string, number> required
          • country map<string, number> required
          • createdAt string required nullable date-time
          • updatedAt string required nullable date-time
  • total 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/team

Create new team

team.createTeam · requires x-api-key

Request body application/json

  • name string required min length 3max length 80
  • avatarUrl string nullable

Example

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

Response 200

8 top-level 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