API Reference

Organization

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Admins

List admins

GET/v2/admins

Get an admin by ID

GET/v2/admins/{id}

List admin roles

GET/v2/admins/roles

Update admin away state

PATCH/v2/admins/{id}/away

Update an admin assignment limit

PATCH/v2/admins/{id}/assignment-limit

Bulk update admin workload state

PATCH/v2/admins/bulk

ModelsExpand Collapse

Admin object { id, object, email, 3 more }

id: string

Unique identifier

object: "admin"

Object type identifier

email: optional string

Admin email address

name: optional string

Admin display name

profilePicture: optional string

Profile picture URL

roleId: optional string

Role ID assigned to this admin

AdminAvailability object { adminId, automatic, away, 5 more }

adminId: string

automatic: boolean

away: boolean

changedAt: string

formatdate-time

lastActiveAt: string

formatdate-time

object: "admin_availability"

reason: object { id, label }

id: string

label: string

reassignReplies: boolean

AssignmentLimit object { adminId, effectiveLimit, limit, 3 more }

adminId: string

effectiveLimit: number

limit: number

mode: "inherit" or "custom" or "unlimited"

One of the following:

"inherit"

"custom"

"unlimited"

object: "assignment_limit"

paused: boolean

AdminListResponse object { data, nextCursor, object, pagination }

data: array of Admin { id, object, email, 3 more }

Array of admins

id: string

Unique identifier

object: "admin"

Object type identifier

email: optional string

Admin email address

name: optional string

Admin display name

profilePicture: optional string

Profile picture URL

roleId: optional string

Role ID assigned to this admin

nextCursor: string

Cursor for fetching the next page (cursor-based pagination)

object: "list"

Object type identifier

pagination: optional object { limit, page, total, totalPages }

Pagination metadata for page-based requests

limit: number

Items per page

page: number

Current page number

total: number

Total number of items

totalPages: number

Total number of pages

AdminListRolesResponse object { data, nextCursor, object }

data: array of object { id, name, object, permissions }

Array of admin roles

id: string

Role unique identifier

name: string

Role name

object: "admin_role"

Object type identifier

permissions: object { auto_approve_posts, manage_api, manage_billing, 44 more }

Role permissions

auto_approve_posts: optional boolean

Auto-approve posts

manage_api: optional boolean

Manage API settings

manage_billing: optional boolean

Manage billing

manage_boards: optional boolean

Manage boards

manage_branding: optional boolean

Manage branding

manage_changelogs: optional boolean

Manage changelogs

manage_comments: optional boolean

Manage comments

manage_comments_private: optional boolean

Manage private comments

manage_conversation_tags: optional boolean

Manage conversation tag definitions

manage_custom_domain: optional boolean

Manage custom domain

manage_custom_fields: optional boolean

Manage custom fields

manage_help_center: optional boolean

Manage help center

manage_integrations: optional boolean

Manage integrations

manage_moderation_settings: optional boolean

Manage moderation settings

manage_notifications: optional boolean

Manage notifications

manage_outbound: optional boolean

Manage outbound messages

manage_outbound_state: optional boolean

Manage outbound message state

manage_post_tags: optional boolean

Manage post tags

manage_prioritization: optional boolean

Manage prioritization

manage_roadmap: optional boolean

Manage roadmap

manage_sso: optional boolean

Manage SSO

manage_statuses: optional boolean

Manage post statuses

manage_surveys: optional boolean

Manage surveys

manage_team_members: optional boolean

Manage team members

manage_user_roles: optional boolean

Manage user roles

manage_users: optional boolean

Manage users

moderate_comments: optional boolean

Moderate comments

moderate_posts: optional boolean

Moderate posts

post_export: optional boolean

Export posts

post_import: optional boolean

Import posts

post_merge: optional boolean

Merge posts

post_vote_on_behalf: optional boolean

Vote on posts on behalf of users

set_comment_pinned: optional boolean

Pin/unpin comments

set_conversation_tags: optional boolean

Apply and remove conversation tags

set_post_assignee: optional boolean

Assign posts

set_post_author: optional boolean

Set post author

set_post_category: optional boolean

Set post category/board

set_post_custom_fields: optional boolean

Set post custom fields

set_post_eta: optional boolean

Set post ETA

set_post_pinned: optional boolean

Pin/unpin posts

set_post_status: optional boolean

Set post status

set_post_tags: optional boolean

Set post tags

use_integrations: optional boolean

Use integrations

view_comments_private: optional boolean

View private comments

view_posts_private: optional boolean

View private posts

view_private_post_tags: optional boolean

View private post tags

view_users: optional boolean

View users

nextCursor: string

Cursor for fetching the next page (cursor-based pagination)

object: "list"

Object type identifier

AdminUpdateBulkResponse object { data, object, operation, updatedCount }

data: array of object { adminId, assignmentLimit, availability, object }

adminId: string

assignmentLimit: AssignmentLimit { adminId, effectiveLimit, limit, 3 more }

adminId: string

effectiveLimit: number

limit: number

mode: "inherit" or "custom" or "unlimited"

One of the following:

"inherit"

"custom"

"unlimited"

object: "assignment_limit"

paused: boolean

availability: AdminAvailability { adminId, automatic, away, 5 more }

adminId: string

automatic: boolean

away: boolean

changedAt: string

formatdate-time

lastActiveAt: string

formatdate-time

object: "admin_availability"

reason: object { id, label }

id: string

label: string

reassignReplies: boolean

object: "admin_workload_state"

object: "bulk_result"

operation: "away" or "assignment_limit"

One of the following:

"away"

"assignment_limit"

updatedCount: number

minimum0