◐ Shell
reader mode source ↗
Search docs... ⌘K
API Status Get API Key

Buffer API

Copy Page

Connect Buffer to your agents, automation tools, or build something entirely new.

Account

Queries 1

QUERY account : Account!

Retrieves the authenticated user's account information

Example Response 
{
  "data": {
    "account": {
      "id": "...",
      "email": "...",
      "backupEmail": "...",
      "avatar": "..."
    }
  }
}

Outputs 1

OUTPUT Account
Account is a representation of a Buffer user.
Fields 10
id : ID!
Unique identifier for the account
email : String!
Primary email address for the account
backupEmail : String
Backup email address for account recovery
avatar : String!
URL to the account's avatar image
createdAt : DateTime
Date the account was created in the Core DB. For older customers, it's possible a Publish account existed in the Publish DB for this customer before this date
organizations (filter: OrganizationFilterInput) : [Organization!]!
timezone : String
The account-level timezone - this is used as a default input for streaks, posting plans, and new channel channel connections.
name : String
The account name, different from the organization name
preferences : Preferences
The accounts preferences
connectedApps : [ConnectedApp!]
The connected apps for the account

Types 2

TYPE ConnectedApp
Connected App
Fields 6
clientId : ID!
The id of the connectedApp.
userId : ID!
The id of the user that has granted access to the app.
name : String!
The name of the connected app.
description : String!
A brief description of the connected app.
website : String!
The website URL of the connected app.
createdAt : DateTime!
The date and time when the connected app was created.
TYPE Preferences
Account preferences
Fields 3
timeFormat : String
startOfWeek : String
defaultScheduleOption : ScheduleOption!

Enums 1

Scalars 2

SCALAR AccountId
The `AccountId` scalar represents the MongoDB ObjectId of a Buffer Account
SCALAR DateTime
The `DateTime` scalar represents a date and time following the ISO 8601 standard.

Channels

Queries 2

QUERY channel (input: ChannelInput!) : Channel!

Fetches a single channel using the provided ID

Arguments
Name Type Description
input Required ChannelInput! Query's input.
Example Response 
{
  "data": {
    "channel": {
      "id": "...",
      "allowedActions": [
        "backfillChannel"
      ],
      "scopes": [
        "..."
      ],
      "avatar": "..."
    }
  }
}
QUERY channels (input: ChannelsInput!) : [Channel!]!

Fetch all channels for the organization taking into account the current's user permissions

Arguments
Name Type Description
input Required ChannelsInput! Query's input.
Example Response 
{
  "data": {
    "channels": [
      {
        "id": "...",
        "allowedActions": [
          "backfillChannel"
        ],
        "scopes": [
          "..."
        ],
        "avatar": "..."
      }
    ]
  }
}

Outputs 1

OUTPUT Channel
Channel entity
Fields 27
id : ChannelId!
The ID of the channel
allowedActions : [ChannelAction!]!
The allowed actions for the current user
scopes : [String]!
Scopes requested for a given channel - empty array if we don't have them tracked
avatar : String!
The avatar URL of the channel
createdAt : DateTime!
The creation date of the channel
descriptor : String!
Formatted name of the channel service and type: e.g. 'Twitter Profile' or 'Facebook Page'
displayName : String
The display name of the channel - nullable (reason?)
isDisconnected : Boolean!
Indicates if the channel is properly connected to Buffer
isLocked : Boolean!
Indicates if the channel is locked - Locked channels can't be used for posting. A channel can be locked when the organization downgrades and reduces the channel quantity of their plan.
isNew : Boolean!
Indicates if the channel was recently created (in less than 10 seconds). This is used to determine the redirect modal after channel authorization
postingSchedule : [ScheduleV2!]!
Provides the posting slots for each day of the week
isQueuePaused : Boolean!
Indicates is the queue is paused for the channel. A paused queue means schedules posts won't be published.
showTrendingTopicSuggestions : Boolean!
Indicates if trending topic suggestions should be shown in the composer. When false, users can still access trends via the trending icon button. Defaults to true for backward compatibility.
metadata : ChannelMetadata
Metadata or settings depending on the service type - such as the server URL for Mastodon or Location data for Facebook/GPB
name : String!
The name of the channel - the handle name, username, etc.
organizationId : OrganizationId!
The organization ID of the channel
products : [Product!]
Products that support a given channel
service : Service!
Represents the social network
serviceId : String!
Represents the external ID of the channel on social network API
timezone : String!
The timezone of the channel - Default if not set is Europe/London
type : ChannelType!
The type of the channel - Page, Profile, Business, Group, Account, etc.
updatedAt : DateTime!
The last time the channel was updated
hasActiveMemberDevice : Boolean!
Whether at least one member of the orginization who have access to this channel also has a user device registered for push notifications
postingGoal : PostingGoal
The posting goal for the channel
externalLink : String
The channel's URL on the social network (e.g. instagram.com/username or facebook.com/page) Returns null if the channel is not supported
linkShortening : ChannelLinkShortening!
Link Shortening settings for the channel
weeklyPostingLimit : WeeklyPostingLimit
Weekly posting limit for the channel

Types 17

TYPE ChannelLinkShortening
Settings for link shortening
Fields 2
config : LinkShorteningConfig
Configuration of link shortening integration. Null if disabled.
isEnabled : Boolean!
If link shortening is enabled for the channel
TYPE IdeaMedia
Media attached to an idea
Fields 7
id : ID!
Unique identifier for the media in Buffer's upload system
url : String!
Direct URL to access the media file
alt : String
Alternative text description for accessibility
thumbnailUrl : String
URL to a smaller version of the media for preview purposes
type : MediaType!
Type of media (e.g., image, video, gif)
size : Int
File size in bytes
source : IdeaMediaSource
Source platform information for the media
TYPE IdeaMediaSource
Media source for the idea, e.g. Unsplash, Gifphy, etc.
Fields 4
name : String!
Name of the media source platform (e.g., 'Unsplash', 'Giphy')
id : String
Unique identifier from the source platform
author : String
Name of the content creator/author
authorUrl : String
URL to the author's profile on the source platform
TYPE LinkShorteningConfig
Link Shortening Configuration
Fields 2
domain : String!
Domain of the link shortener - eg buff.ly, dub.co, or the user's custom domain.
name : String!
Human readable string to describe the link shortening service.
TYPE LocationData
Location data about the channel
Fields 3
location : String
Location of the business associated with the channel
mapsLink : String
Link to the map
googleAccountId : String
Google Account Id of the business
TYPE PinterestBoard
A Pinterest board
Fields 6
id : String!
The ID of the board
serviceId : String!
The ID of the service
name : String!
The board name
url : String!
The board URL
description : String
The board description
avatar : String
The board avatar
TYPE ScheduleV2
Posting schedule for a specific day of the week
Fields 3
day : DayOfWeek!
The day of the week: mon, tue, wed, thu, fri, sat, sun
times : [String!]!
The times the channel is scheduled to post on the day: HH:MM
paused : Boolean!
Indicates if this day is paused in the posting schedule.

Inputs 5

INPUT ChannelInput
Input for the channel query
Fields 1
id : ChannelId!
The ID of the channel to be retrieved
INPUT ChannelsFiltersInput
Filter to pass when fetching channels.
Fields 2
isLocked : Boolean
If not defined, it returns all channels Else, if true, it only returns locked channels if false, it only returns not locked channels
product : Product
If not passed, it return all channels Else, it filters the channels based on what the product supports.
INPUT ChannelsInput
Input to pass when fetching channels.
Fields 2
organizationId : OrganizationId!
The Organization id to fetch channels for
filter : ChannelsFiltersInput
A list of option filters - passing null means we don't want to filter
INPUT IdeaMediaInput
Fields 6
url : String!
The URL of the media
alt : String
Alternative text for the media
thumbnailUrl : String
Thumbnail URL for the media
type : MediaType!
The type of media (image, gif, video, link, document, unsupported). Note: 'video' is not supported via public API
size : Int
The size of the media in bytes
source : IdeaMediaSourceInput
Source information for the media
INPUT IdeaMediaSourceInput
Input type for the source information of media attached to an idea
Fields 5
name : String!
id : String
trigger : String
author : String
for unsplash only
authorUrl : String

Enums 6

ENUM ChannelAction
List of possible actions that can be performed on a Channel
ENUM ChannelType
Channel is a representation of a social media account or page that can be connected to Buffer.
ENUM DayOfWeek
ENUM MediaType
The type of media attached to a post
ENUM Product
Buffer products, buffer is used as all products
ENUM Service
The list of services that can be authorized.

Scalars 1

SCALAR ChannelId
The `ChannelId` scalar represents the MongoDB ObjectId of a Buffer Channel

Posts

Queries 4

QUERY aggregatedPostMetrics (input: AggregatedPostMetricsInput!) : AggregatedPostMetrics! 🧪 Preview

Aggregate normalized post metrics across a filtered post set. Useful for yearly summaries, channel-level rollups, and BI exports without paginating through thousands of posts.

For per-post metrics, use posts(input) or post(input) with a metrics { … } selection — this query is purely for aggregation.

The result always contains a baseline trio of entries: postCount (number of matched posts in the window), reactions, and comments. Posts on networks that don't track reactions or comments contribute 0 to those totals.

Beyond the baseline, additional metric types are returned only when every channel in the filter set supports them. A single-network filter surfaces that network's richer metrics (e.g. impressions, reach, engagementRate on LinkedIn); a mixed-network filter trims the extras to those common to every network in the set.

Arguments
Name Type Description
input Required AggregatedPostMetricsInput! Query's input: organization, date range, optional channel and tag filters. Date range is capped to 365 days.
Example Response 
{
  "data": {
    "aggregatedPostMetrics": {
      "metrics": [
        {
          "type": "reactions",
          "name": "...",
          "description": "...",
          "value": 0
        }
      ],
      "metricsUpdatedAt": "..."
    }
  }
}
QUERY dailyPostingLimits (input: DailyPostingLimitsInput!) : [DailyPostingLimitStatus!]!

Returns daily posting limit status for the given channels on the specified date.

Arguments
Name Type Description
input Required DailyPostingLimitsInput! Query's input.
Example Response 
{
  "data": {
    "dailyPostingLimits": [
      {
        "channelId": "...",
        "sent": 0,
        "scheduled": 0,
        "limit": 0
      }
    ]
  }
}
QUERY post (input: PostInput!) : Post!

Fetches a post by PostID for the given organization: first and last can be set for forward pagination using Relay convention

Arguments
Name Type Description
input Required PostInput! Query's input.
Example Response 
{
  "data": {
    "post": {
      "id": "...",
      "ideaId": "...",
      "status": "draft",
      "via": "buffer"
    }
  }
}
QUERY posts (input: PostsInput!, first: Int, after: String) : PostsResults!

Fetches posts for the given organization: first and last can be set for forward pagination using Relay convention

Arguments
Name Type Description
input Required PostsInput! Query's input.
first Optional Int The number of posts to return
after Optional String The cursor of the post to start fetching from
Example Response 
{
  "data": {
    "posts": {
      "edges": [
        {
          "node": {},
          "cursor": "..."
        }
      ],
      "pageInfo": {
        "startCursor": "...",
        "endCursor": "...",
        "hasPreviousPage": true,
        "hasNextPage": true
      }
    }
  }
}

Mutations 3

MUTATION createPost (input: CreatePostInput!) : PostActionPayload!

Create post for channel

Arguments
Name Type Description
input Required CreatePostInput! The mutation's input
Example Response 
{
  "data": {
    "createPost": {}
  }
}
MUTATION deletePost (input: DeletePostInput!) : DeletePostPayload!

Delete a post by id.

Arguments
Name Type Description
input Required DeletePostInput! No description
Example Response 
{
  "data": {
    "deletePost": {}
  }
}
MUTATION editPost (input: EditPostInput!) : PostActionPayload!

Edit post for channel

Arguments
Name Type Description
input Required EditPostInput! The mutation's input
Example Response 
{
  "data": {
    "editPost": {}
  }
}

Outputs 6

OUTPUT AggregatedPostMetrics 🧪 Preview
Aggregated post metrics across a filtered post set. Each entry in `metrics` mirrors the shape of a `Post.metrics` entry; the total number of matched posts is carried as a regular `PostMetric` entry with `type: postCount`.
Fields 2
metrics : [PostMetric!]!
Normalized metric aggregates across the matched posts. Always includes a baseline trio (`postCount`, `reactions`, `comments`) — posts on networks that don't track reactions or comments contribute 0 to those totals. Beyond the baseline, additional metric types are included only when every channel in the filter set supports them.
metricsUpdatedAt : DateTime
The latest `metricsUpdatedAt` across the matched posts, indicating the freshness of the aggregate. Metrics are refreshed daily, so values can be up to ~24h behind the source network. Null when no posts matched the filter.
OUTPUT DailyPostingLimitStatus
Status of daily posting limits for a channel on a given day.
Fields 5
channelId : ChannelId!
The channel ID this status refers to.
sent : Int!
Number of posts already sent on this day.
scheduled : Int!
Number of posts scheduled for this day.
limit : Int
The network daily posting limit. Null means unlimited.
isAtLimit : Boolean!
Whether the channel has reached its daily posting limit.
OUTPUT Post
Post entity
Fields 27
id : PostId!
ObjectId of the post
ideaId : IdeaId
Is set when the Post is generated from an Idea
status : PostStatus!
status
via : PostVia!
Indicates if the post is created from Buffer or the API
schedulingType : SchedulingType
Scheduling type can be null if the post was created natively on the social network without using notification publishing or automatic publishing
author : Author
Represents the user who created the post
isCustomScheduled : Boolean!
Indicates whether time to publish was manually selected by the user
createdAt : DateTime!
Date when the post was created
updatedAt : DateTime!
Date when the post was updated
dueAt : DateTime
Date when the post is scheduled to be published
sentAt : DateTime
Date when the post is published
text : String!
Text content of the Post
externalLink : String
The external URL of the post at the destination service
metadata : PostMetadata
Metadata of the post which differs based on the social network/service @see post.metadata.graphql
channelId : ChannelId!
channel ID (faster than resolving the channnel.id)
channelService : Service!
channel service (faster than resolving the channnel.service)
channel : Channel!
channel
tags : [Tag!]!
tags - sorted by name in ascending order
notes : [Note!]!
notes
notificationStatus : NotificationStatus
notificationStatus: notified or markedAsPublished
error : PostPublishingError
error
assets : [Asset!]!
assets
metrics : [PostMetric!]
Metrics for the sent post. If post is not yet sent, this field will be null
metricsUpdatedAt : DateTime
Timestamp of when `metrics` were last refreshed from the network. Null until the daily ingestion job has processed the post. Buffer pulls fresh metrics once per day, so this can lag the network value by ~24h.
allowedActions : [PostAction!]!
Indicates what actions the current account can perform on the post
sharedNow : Boolean!
Indicates whether the post was shared via publish now action
shareMode : ShareMode!
Indicates the share mode of the post (e.g., addToQueue, shareNext, shareNow, customScheduled)
OUTPUT PostsResults
Results for the posts query.
Fields 2
edges : [PostsEdge!]
The list of posts that match the query.
pageInfo : PaginationPageInfo!
Information to aid in pagination.

Types 44

TYPE Annotation
Annotation representing all the entities in the text
Fields 5
type : AnnotationType!
The type of the annotation
indices : [Int!]!
The indices of the annotation in the text
content : String!
The content of the annotation. Annotations can sometimes be different from the actual text content. E.g., Mastodon mentions have 'text: @buffer', but includes the server name in the content, 'content: @buffer@threads.net'
text : String!
The text representation of the annotation, eg '@buffer'
url : String!
The URL the annotation points to
TYPE Author
Represent the author of a post or note.
Fields 5
id : AccountId!
The unique identifier of the author.
email : String!
The email address of the author.
avatar : String!
The avatar URL of the author.
isDeleted : Boolean!
Indicates whether the author is a deleted.
name : String
The name of the author. Null if the user has not yet set a name.
TYPE DeletePostSuccess
deletePost success response returns the post id that was deleted.
Fields 1
id : PostId!
Post id that was delete.
TYPE InstagramGeolocation
Instagram Geolocation
Fields 2
id : String
The id of this location
text : String
The name of this location
TYPE InstagramStickerFields
Instagram fields for reminder-based publishing. Upon the reminder for publishing, the user is prompted to copy and paste these fields into the Instagram app to complete the post.
Fields 5
text : String
Text for the Story or Reel
music : String
Placeholder text for the post's music
products : String
Placeholder text for the post's linked products
topics : String
Placeholder text for the post's topics (Reels only)
other : String
Additional field for any other post content
TYPE LinkAttachment
Link attachment
Fields 6
url : String!
URL that the link asset has been built from
expandedUrl : String
Full URL that the link asset has been built from
text : String!
Description for the scraped link
thumbnails : [String!]!
Thumbnails of media available in the link
thumbnail : String
Selected thumbnail for this link preview
title : String!
Title for the link attachment
TYPE Note
Note entity
Fields 7
id : NoteId!
The unique identifier of the note.
text : String!
The content of the note.
type : NoteType!
The type of the note.
author : Author!
The author of the note - null if the user is deleted or left the organization.
createdAt : DateTime!
The date and time when the note was created.
updatedAt : DateTime
The date and time when the note was last edited.
allowedActions : [NoteAction!]!
The allowed actions a user can perform on the note.
TYPE NotFoundError
Error returned when the resource is not found
Fields 1
message : String!
Error message
TYPE PaginationPageInfo
Information to aid in pagination.
Fields 4
startCursor : String
The first cursor in the list. It can be used to fetch the previous page.
endCursor : String
The last cursor in the list. It can be used to fetch the next page.
hasPreviousPage : Boolean!
When set to true, it means there is a previous page available. Will always return false for now as we only support forward pagination.
hasNextPage : Boolean!
When set to true, it means there is a next page available.
TYPE PostActionSuccess
Success response returns the full up-to-date post from after the action was performed.
Fields 1
post : Post!
Post on which the action was successfully performed.
TYPE PostingGoal
Represents a posting goal for a channel, including target, progress, and status information.
Fields 6
goal : Int!
The target number of posts for this goal.
sentCount : Int!
The number of posts that have been sent (published or ingested) for this goal.
scheduledCount : Int!
The number of posts that are scheduled to be sent for this goal.
status : PostingGoalStatus!
The current status of the posting goal.
periodStart : DateTime!
The start date of the period for this posting goal.
periodEnd : DateTime!
The end date of the period for this posting goal.
TYPE PostMetric 🧪 Preview
A single metric for a post (or an entry in an aggregated metrics response).
Fields 5
type : PostMetricType!
The type of metric. Cross-network metrics use unified naming (`reactions`, `comments`, etc.); network-specific metrics retain their network's vocabulary (`saves`, `quotes`, etc.). See `PostMetricType` for the full catalog including deprecated values.
name : String!
The human-readable name of the metric (e.g. "Reactions", "Eng. Rate").
description : String!
A human-readable description of what the metric represents.
value : Float!
The metric value. Defaults to 0 when the network did not report the metric.
unit : PostMetricUnit!
The unit (count vs percentage) of `value`.
TYPE PostPublishingError
Post publishing error
Fields 3
message : String!
Error message to display
supportUrl : String
Link to a help center article to help resolve the error
rawError : String
The original error from the publishing service (internal use only)
TYPE PostsEdge
Represent a node in the pagination result using the Connect Relay convention.
Fields 2
node : Post!
Represents the current post in the list.
cursor : String!
Opaque cursor to be used in pagination to fetch from current node.
TYPE PublishingTag
Tag associated with a post
Fields 3
id : ID!
color : String!
Hex color for tag e.g #F523F1
name : String!
TYPE RestProxyError
Error proxied from the REST API response
Fields 3
message : String!
An error message from the REST API response that we proxied here
link : String
Link to our Help center from the REST API response
code : Int
Error code from the REST API response - https://buffer.com/developers/api/errors
TYPE Tag
Tag entity
Fields 4
id : TagId!
ObjectId of the tag
color : String!
Hex color for tag e.g '#F523F1'
name : String!
Name of the tag e.g 'Summer sales'
isLocked : Boolean!
Locked tag cannot be assigned to new items in the UI. A Tag is locked after a customer downgrades and has more tags than the free plan limit allows
TYPE UserTag
User tag in the image
Fields 3
handle : String!
The handle (username) of the tagged account, without the leading @.
x : Float!
Horizontal position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image width from the left edge (0.5 is the horizontal center).
y : Float!
Vertical position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image height from the top edge (0.5 is the vertical center).
TYPE VoidMutationError
Error implementation that allows clients to resolve the MutationError on mutations that do not currently have typed errors. This allows clients to automatically handle errors that may be added to a mutation in future. Do not directly throw this error, use a custom typed error instead
Fields 1
message : String!
Error message
TYPE WeeklyPostingLimit
Weekly posting limit for a channel
Fields 3
sent : Int!
The number of posts the channel has sent this week
scheduled : Int!
The number of posts the channel has scheduled for this week
limit : Int!
The weekly posting limit for the channel
TYPE YoutubeCategory
Fields 2
categoryId : String!
title : String!
TYPE Asset
Asset interface with common fields
Fields 5
id : ID
The ID of the asset in the database
type : AssetType!
The type of the asset
mimeType : String!
The MIME type of the asset
source : String!
URL to the file source
thumbnail : String!
URL to the static thumbnail of the asset
TYPE GoogleBusinessPostDetails
GoogleBusiness Metadata details

Inputs 43

INPUT AggregatedPostMetricsInput 🧪 Preview
Input for the `aggregatedPostMetrics` query.
Fields 5
organizationId : OrganizationId!
The organization ID
startDateTime : DateTime!
Start of the aggregation window. Consumers typically pass UTC midnight of the first calendar day in the window, for example `2026-01-01T00:00:00Z`.
endDateTime : DateTime!
End of the aggregation window. Consumers typically pass UTC midnight of the last calendar day in the window (the backend treats the range as inclusive of that day), for example `2026-01-31T00:00:00Z`. Date range is capped to 365 days.
channelIds : [ChannelId!]
Optional list of channel IDs to filter by. When omitted (null), the aggregate spans every channel in the organization the actor has insights access to. When set to an empty array, no channels match and the result is empty.
tags : TagComparator
Filter to posts with specific tags. When omitted, all posts are included regardless of tags.
INPUT AnnotationInputFacebook
Annotation representing all the entities in the text
Fields 4
content : String!
The content of the annotation, e.g. '107509875938399'
indices : [Int!]!
The indices of the annotation in the text, e.g. [6, 9] (from 6 to 9 characters in the text)
text : String!
The text representation of the annotation, eg 'Buffer'
url : String!
The URL the annotation points to, e.g. https://www.facebook.com/107509875938399
INPUT AnnotationInputLinkedIn
Annotation representing all the entities in the text
Fields 7
id : String!
The id of the annotation, e.g. 1521226
link : String!
The link of the annotation, e.g. https://www.linkedin.com/company/bufferapp
entity : String!
The entity of the annotation, e.g. urn:li:organization:1521226
vanityName : String!
The vanity name of the annotation, e.g. bufferapp
localizedName : String!
The localized name of the annotation, e.g. Buffer
start : Int!
The start of the annotation, e.g. 5
length : Int!
The length of the annotation, e.g. 6
INPUT AssetInput
A single entity's asset. Exactly one variant must be provided.
Fields 4
image : ImageAssetInput
Image asset
video : VideoAssetInput
Video asset
document : DocumentAssetInput
Document asset
link : LinkAssetInput
Link asset
INPUT CreatePostInput
Create post's request input. Note: `assets.videos` and `metadata.{service}.linkAttachment` are mutually exclusive. If both are provided, the video is ignored.
Fields 13
ideaId : IdeaId
Is set when the Post is generated from an Idea
draftId : DraftId
Is set when the Post is generated from a Draft
schedulingType : SchedulingType!
Scheduling type to indicate notification publishing or automatic publishing
dueAt : DateTime
Date when the post is scheduled to be published
text : String
Text content of the Post. Note: for threaded posts, this needs to match the first item in the `thread` array.
metadata : PostInputMetaData
Metadata of the post which differs based on the social network/service
channelId : ChannelId!
Channel's Id for which we want to create the post
tagIds : [TagId!]
List of tag IDs
assets : [AssetInput!]!
Ordered list of assets on this post.
mode : ShareMode!
How the post is being scheduled.
source : String
source where the composer was initiated from, used for tracking.
aiAssisted : Boolean
If this post was created with the help of AI
saveToDraft : Boolean
If true, saves the post as a draft instead of scheduling it. When saving as draft: - Post status will be 'draft' instead of 'buffer' - Posting limits are not checked - The post will not be published until explicitly scheduled
INPUT DailyPostingLimitsInput
Input for the dailyPostingLimits query.
Fields 2
channelIds : [ChannelId!]!
List of channel IDs to check limits for. All channels must belong to the same organization.
date : DateTime
The date to check limits for. Defaults to today if not provided.
INPUT DateTimeComparator
Comparator for filtering by date
Fields 2
start : DateTime
Include results with dates equal to or after the specified date
end : DateTime
Include results with dates equal to or before the specified date
INPUT DeletePostInput
deletePost mutation deletes a post by id.
Fields 1
id : PostId!
Post id to delete.
INPUT DocumentAssetInput
Document asset
Fields 3
url : String!
Document URL
title : String!
Document title
thumbnailUrl : String!
Document thumbnail URL
INPUT EditPostInput
Edit post's request input. Note: `assets.videos` and `metadata.{service}.linkAttachment` are mutually exclusive. If both are provided, the video is ignored.
Fields 13
id : PostId!
ID of the post to edit
ideaId : IdeaId
Is set when the Post is generated from an Idea
draftId : DraftId
Is set when the Post is generated from a Draft
schedulingType : SchedulingType!
Scheduling type to indicate notification publishing or automatic publishing
dueAt : DateTime
Date when the post is scheduled to be published
text : String
Text content of the Post. Note: for threaded posts, this needs to match the first item in the `thread` array.
metadata : PostInputMetaData
Metadata of the post which differs based on the social network/service
tagIds : [TagId!]
tags
assets : [AssetInput!]
Ordered list of assets on this post. Omit to preserve the existing list, pass an empty array to clear it
mode : ShareMode!
How the post is being scheduled.
source : String
source where the composer was initiated from, used for tracking.
aiAssisted : Boolean
If this post was edited with the help of AI
saveToDraft : Boolean
If true, saves the post as a draft instead of keeping it scheduled. When saving as draft: - Post status will be 'draft' instead of 'buffer' - The post will not be published until explicitly scheduled
INPUT ImageAssetInput
Image asset
Fields 3
url : String!
URL to the file source
thumbnailUrl : String
URL to the static thumbnail of the asset
metadata : ImageMetadataInput
Image specific metadata
INPUT ImageDimensionsInput
Image dimensions
Fields 2
width : Int!
Image width in pixels
height : Int!
Image height in pixels
INPUT InstagramGeolocationInput
Instagram Geolocation
Fields 2
id : String
The id of this location
text : String
The name of this location
INPUT InstagramStickerFieldsInput
Instagram fields for reminder-based publishing. Upon the reminder for publishing, the user is prompted to copy and paste these fields into the Instagram app to complete the post.
Fields 5
text : String
Text for the Story or Reel
music : String
Placeholder text for the post's music
products : String
Placeholder text for the post's linked products
topics : String
Placeholder text for the post's topics (Reels only)
other : String
Additional field for any other post content
INPUT LinkAssetInput
Link attached to the post
Fields 4
url : String!
URL to the link
title : String
Title of the link
description : String
Description of the link
thumbnailUrl : String
Thumbnail URL of the link
INPUT LinkAttachmentInput
Link attachment
Fields 1
url : String!
URL that the link asset has been built from
INPUT PostInput
Input for the post query
Fields 1
id : PostId!
The ID of the post to be retrieved
INPUT PostsFiltersInput
Filter to apply to the posts query
Fields 8
channelIds : [ChannelId!]
When set, it will filter posts by channel
startDate : DateTime
When set, it will return posts with createdAt or dueAt date after startDate
endDate : DateTime
When set, it will return posts with createdAt or dueAt date before endDate
status : [PostStatus!]
When set, it will filter posts by status
tags : TagComparator
Filter posts by tags. Supports specific tags, untagged posts, or union of both.
tagIds : [TagId!]
When set, it will filter posts by tag
dueAt : DateTimeComparator
When set, it will filter posts by their scheduled posting date
createdAt : DateTimeComparator
When set, it will filter posts by the date they were created
INPUT PostsInput
Input for the posts query
Fields 3
organizationId : OrganizationId!
The Organization id to fetch posts for
filter : PostsFiltersInput
The filters to apply to the posts query
sort : [PostSortInput!]
The sort to apply to the posts results
INPUT PostSortInput
Sort order of post results. List multiple to create tie-breaking order.
Fields 2
field : PostSortableKey!
The field to sort by.
direction : SortDirection!
The direction to sort by.
INPUT TagComparator
Comparator for filtering by tags
Fields 2
in : [TagId!]!
Include results that have any of the specified tags (union/OR).
isEmpty : Boolean!
When true, include results that have no tags assigned. Can be combined with 'in' for union filtering. Defaults to false if not specified.
INPUT TagInput
Input type for tag information used in idea creation
Fields 3
id : ID!
name : String!
color : String!
INPUT UserTagInput
User tag in the image
Fields 3
handle : String!
The handle (username) of the account to tag, without the leading @.
x : Float!
Horizontal position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image width from the left edge (0.5 is the horizontal center). Pass a number, not a string, and do not use pixel coordinates; to convert, divide the pixel X by the image width.
y : Float!
Vertical position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image height from the top edge (0.5 is the vertical center). Pass a number, not a string, and do not use pixel coordinates; to convert, divide the pixel Y by the image height.
INPUT VideoAssetInput
Video asset
Fields 3
url : String!
URL to the file source
thumbnailUrl : String
URL to the thumbnail of the video
metadata : VideoMetadataInput
Video specific metadata

Enums 21

ENUM AnnotationType
List of possible types for an annotation
ENUM AssetType
Asset types
ENUM GoogleBusinessPostActionType
List of possible types for GBP cta
ENUM NoteAction
List of possible actions that can be performed on a note
ENUM NoteType
The type of a note.
ENUM NotificationStatus
List of possible statuses for a notification
ENUM PostAction
List of possible actions that can be performed on a Post
ENUM PostingGoalStatus
PostingGoalStatus is used to track the status of a posting goal.
ENUM PostMetricType 🧪 Preview
List of possible metrics available for a Post. Values fall into three groups: - **Cross-network normalized** (reactions, comments, shares, reposts, reach, impressions, views, clicks, engagementRate): Used wherever a concept maps cleanly across networks. Per-network adapters normalize their native names (e.g., Instagram `likes` → `reactions`, Twitter `retweets` → `reposts`). - **Network-specific** (saves, follows, quotes, viewers, totalTimeWatched, likes): Real metrics that don't have a cross-network equivalent. `likes` is intentionally distinct from `reactions` on Facebook — Facebook's Graph API surfaces them separately. - **Aggregation-only** (postCount): Meaningful only on aggregate endpoints; never emitted per-post. Deprecated values are pre-normalization legacy or tied to features being removed. They're kept in the enum for backwards compatibility until clients migrate.
ENUM PostMetricUnit 🧪 Preview
The unit representing the value of a PostMetric.
ENUM PostSortableKey
Key of collection to use for sorting
ENUM PostStatus
List of possible statuses for a Post
ENUM PostType
List of possible types for a Post. Some services may have different types (e.g., Instagram has story, reel, post but Twitter has only post)
ENUM PostTypeFacebook
List of specific post types available for Facebook
ENUM PostTypeGoogleBusiness
List of specific post types available for Google Business profiles
ENUM PostVia
List of possible ways to create a Post
ENUM SchedulingType
Indicates whether the post was scheduled for notification publishing or automatic publishing
ENUM ShareMode
How the post is being scheduled.
ENUM SortDirection
Direction to sort the results by.
ENUM YoutubeLicense
List of license types
ENUM YoutubePrivacy
List of privacy types

Scalars 5

SCALAR DraftId
The `DraftId` scalar represents the MongoDB ObjectId of a Buffer Draft
SCALAR NoteId
The `NoteId` scalar represents the MongoDB ObjectId of a Buffer Note
SCALAR PostGroupId
The `PostGroupId` scalar represents the MongoDB ObjectId of a Buffer Post Group.
SCALAR PostId
The `PostId` scalar represents the MongoDB ObjectId of a Buffer Post
SCALAR TagId
The `TagId` scalar represents the MongoDB ObjectId of a Buffer Tag

Ideas

Mutations 1

MUTATION createIdea (input: CreateIdeaInput!) : CreateIdeaPayload!

Create a new idea with the given content and metadata

Arguments
Name Type Description
input Required CreateIdeaInput! Input to create an idea
Example Response 
{
  "data": {
    "createIdea": {}
  }
}

Outputs 1

Types 7

TYPE Idea
Ideas are the main entity in the create space
Fields 7
id : ID!
Unique identifier for the idea
organizationId : ID!
ID of the organization that owns this idea
content : IdeaContent!
The actual content and metadata of the idea
groupId : ID
ID of the group this idea belongs to (if any)
position : Float
Numerical position for ordering within a group
createdAt : Int!
Unix timestamp of when the idea was created
updatedAt : Int!
Unix timestamp of when the idea was last modified
TYPE IdeaContent
Content of an idea
Fields 7
title : String
Title or headline of the idea
text : String
Main body text or description of the idea
media : [IdeaMedia!]
List of media items attached to the idea
tags : [PublishingTag!]!
Tags used to categorize and organize the idea
aiAssisted : Boolean!
Indicates whether AI tools were used in creating this idea
services : [Service!]!
Services tagged by the user - this is typically used to annotate ideas with their target services
date : DateTime
DateTime set by user associated with the idea - this often reflects a target publish date.
TYPE IdeaResponse
createIdea response type
Fields 2
idea : Idea
The affected idea
refreshIdeas : Boolean!
If true, the client should refresh the ideas list because other ideas might have been moved
TYPE InvalidInputError
Error returned when the input is invalid
Fields 1
message : String!
Error message
TYPE LimitReachedError
Error returned when the limit is reached
Fields 1
message : String!
Error message
TYPE UnauthorizedError
Error returned when the user is not authorized to perform the action
Fields 1
message : String!
Error message
TYPE UnexpectedError
Error returned when unexpected error occurs
Fields 1
message : String!
Error message

Inputs 3

INPUT CreateIdeaInput
createIdea input type
Fields 5
organizationId : ID!
Organization ID that will own the idea
content : IdeaContentInput!
Content and metadata for the new idea
cta : String
Call-to-action identifier for analytics tracking
group : IdeaGroupInput
Group placement (null for unassigned group)
templateId : String
Template ID used to create the idea
INPUT IdeaContentInput
content input for creating/updating an idea
Fields 7
title : String
Title or headline of the idea
text : String
Main body text or description
media : [IdeaMediaInput!]
List of media items to attach
tags : [TagInput!]
Tags to categorize the idea
aiAssisted : Boolean
Whether AI tools were used in creation
services : [Service!]
Services associated with the idea for targeting specific platforms
date : DateTime
Target date for the idea, often used for planning publish schedules
INPUT IdeaGroupInput
idea group input for create/update
Fields 2
groupId : ID
Target group ID (null for unassigned group)
placeAfterId : ID
ID of idea to place after (null for top position)

Scalars 1

SCALAR IdeaId
The `IdeaId` scalar represents the MongoDB ObjectId of a Buffer Idea

Organizations

Types 3

TYPE MemberConnection
Represents the members connection edge. Later, we can add the list of members with the page info to follow our connection edge pattern.
Fields 1
totalCount : Int!
The total count of team members counting the org owner and team members from the Publish DB.
TYPE Organization
Organization is a representation of a Buffer Organization.
Fields 7
id : OrganizationId!
The ID of the organization.
channelCount : Int!
The total number of channels connected to the organization.
limits : OrganizationLimits!
The limits of the organization. Can be used to check if the organization has reached the limit of channels, members, etc.
members : MemberConnection!
The members of the organization. Can be used to check the total number of members in the organization. In the future, it might contain more information about the members.
name : String!
The name of the organization.
ownerEmail : String!
The owner email of the organization.
shouldEnforce2FASetup : Boolean!
Whether the requesting actor should be sent through 2FA setup before they can use this organization. Derived: true only when the org has `settings.enforce2FA` ON, the `organization-enforced-2fa` rollout Split is ON for the org, and the actor has no 2FA configured on their own account. This is the single source of truth for the forced-2FA gate; app-shell and publish-frontend redirect to the setup flow when it's true. Exposed to the API gateway so any stitched consumer reads the same value.
TYPE OrganizationLimits
Resource limits for an organization including channels, members, and content limits
Fields 10
channels : Int!
members : Int!
scheduledPosts : Int!
scheduledThreadsPerChannel : Int!
scheduledStoriesPerChannel : Int!
generateContent : Int!
tags : Int!
ideas : Int!
ideaGroups : Int!
savedReplies : Int!

Inputs 1

INPUT OrganizationFilterInput
Allow retrieving a specific Organization
Fields 1
organizationId : String!

Enums 1

ENUM OrganizationAction
List of possible actions that can be performed on a Organization

Scalars 1

SCALAR OrganizationId
The `OrganizationId` scalar represents the MongoDB ObjectId of a Buffer Organization

Other

Types 8

TYPE DocumentAsset
Document asset
Fields 6
id : ID
The ID of the asset in the database
type : AssetType!
The type of the asset
mimeType : String!
The MIME type of the asset
source : String!
URL to the file source
thumbnail : String!
URL to the static thumbnail of the asset
document : DocumentMetadata!
Document specific metadata
TYPE ImageAsset
Image asset
Fields 6
id : ID
The ID of the asset in the database
type : AssetType!
The type of the asset
mimeType : String!
The MIME type of the asset
source : String!
URL to the file source
thumbnail : String!
URL to the static thumbnail of the asset
image : ImageMetadata!
Image specific metadata
TYPE VideoAsset
Video asset
Fields 6
id : ID
The ID of the asset in the database
type : AssetType!
The type of the asset
mimeType : String!
The MIME type of the asset
source : String!
URL to the file source
thumbnail : String!
URL to the static thumbnail of the asset
video : VideoMetadata!
Video specific metadata
TYPE MutationError
Base Mutation Error type
Fields 1
message : String!
Error message

Scalars 2

SCALAR InvitationId
The `InvitationId` scalar represents the MongoDB ObjectId of a pending team invitation
SCALAR Uuid
The `Uuid` scalar represents an RFC 4122 v4 UUID, e.g. `550e8400-e29b-41d4-a716-446655440000`.

Directives 1

@oneOf

Indicates exactly one field must be supplied and this field must not be null.

Locations: INPUT_OBJECT

TYPE

Account

Account is a representation of a Buffer user.

Fields 10

id : ID!

Unique identifier for the account

email : String!

Primary email address for the account

backupEmail : String

Backup email address for account recovery

avatar : String!

URL to the account's avatar image

createdAt : DateTime

Date the account was created in the Core DB. For older customers, it's possible a Publish account existed in the Publish DB for this customer before this date

organizations (filter: OrganizationFilterInput) : [Organization!]!
No description provided.
Arguments
Name Type Description
filter Optional OrganizationFilterInput No description
timezone : String

The account-level timezone - this is used as a default input for streaks, posting plans, and new channel channel connections.

name : String

The account name, different from the organization name

preferences : Preferences

The accounts preferences

connectedApps : [ConnectedApp!]

The connected apps for the account

TYPE 🧪 Preview

AggregatedPostMetrics

Aggregated post metrics across a filtered post set. Each entry in metrics mirrors the shape of a Post.metrics entry; the total number of matched posts is carried as a regular PostMetric entry with type: postCount.

Fields 2

metrics : [PostMetric!]!

Normalized metric aggregates across the matched posts. Always includes a baseline trio (postCount, reactions, comments) — posts on networks that don't track reactions or comments contribute 0 to those totals. Beyond the baseline, additional metric types are included only when every channel in the filter set supports them.

metricsUpdatedAt : DateTime

The latest metricsUpdatedAt across the matched posts, indicating the freshness of the aggregate. Metrics are refreshed daily, so values can be up to ~24h behind the source network. Null when no posts matched the filter.

TYPE

Annotation

Annotation representing all the entities in the text

Fields 5

type : AnnotationType!

The type of the annotation

indices : [Int!]!

The indices of the annotation in the text

content : String!

The content of the annotation. Annotations can sometimes be different from the actual text content. E.g., Mastodon mentions have 'text: @buffer', but includes the server name in the content, 'content: @buffer@threads.net'

text : String!

The text representation of the annotation, eg '@buffer'

url : String!

The URL the annotation points to

TYPE

Author

Represent the author of a post or note.

Fields 5

id : AccountId!

The unique identifier of the author.

email : String!

The email address of the author.

avatar : String!

The avatar URL of the author.

isDeleted : Boolean!

Indicates whether the author is a deleted.

name : String

The name of the author. Null if the user has not yet set a name.

TYPE

Channel

Channel entity

Fields 27

id : ChannelId!

The ID of the channel

allowedActions : [ChannelAction!]!

The allowed actions for the current user

scopes : [String]!

Scopes requested for a given channel - empty array if we don't have them tracked

avatar : String!

The avatar URL of the channel

createdAt : DateTime!

The creation date of the channel

descriptor : String!

Formatted name of the channel service and type: e.g. 'Twitter Profile' or 'Facebook Page'

displayName : String

The display name of the channel - nullable (reason?)

isDisconnected : Boolean!

Indicates if the channel is properly connected to Buffer

isLocked : Boolean!

Indicates if the channel is locked - Locked channels can't be used for posting. A channel can be locked when the organization downgrades and reduces the channel quantity of their plan.

isNew : Boolean!

Indicates if the channel was recently created (in less than 10 seconds). This is used to determine the redirect modal after channel authorization

postingSchedule : [ScheduleV2!]!

Provides the posting slots for each day of the week

isQueuePaused : Boolean!

Indicates is the queue is paused for the channel. A paused queue means schedules posts won't be published.

showTrendingTopicSuggestions : Boolean!

Indicates if trending topic suggestions should be shown in the composer. When false, users can still access trends via the trending icon button. Defaults to true for backward compatibility.

name : String!

The name of the channel - the handle name, username, etc.

organizationId : OrganizationId!

The organization ID of the channel

products : [Product!]

Products that support a given channel

service : Service!

Represents the social network

serviceId : String!

Represents the external ID of the channel on social network API

timezone : String!

The timezone of the channel - Default if not set is Europe/London

type : ChannelType!

The type of the channel - Page, Profile, Business, Group, Account, etc.

updatedAt : DateTime!

The last time the channel was updated

hasActiveMemberDevice : Boolean!

Whether at least one member of the orginization who have access to this channel also has a user device registered for push notifications

postingGoal : PostingGoal

The posting goal for the channel

linkShortening : ChannelLinkShortening!

Link Shortening settings for the channel

weeklyPostingLimit : WeeklyPostingLimit
Deprecated

Weekly posting limit for the channel

Deprecation reason: This field is not used anymore

TYPE

ChannelLinkShortening

Settings for link shortening

Fields 2

config : LinkShorteningConfig

Configuration of link shortening integration. Null if disabled.

isEnabled : Boolean!

If link shortening is enabled for the channel

TYPE

ConnectedApp

Connected App

Fields 6

clientId : ID!

The id of the connectedApp.

userId : ID!

The id of the user that has granted access to the app.

name : String!

The name of the connected app.

description : String!

A brief description of the connected app.

website : String!

The website URL of the connected app.

createdAt : DateTime!

The date and time when the connected app was created.

TYPE

DailyPostingLimitStatus

Status of daily posting limits for a channel on a given day.

Fields 5

channelId : ChannelId!

The channel ID this status refers to.

sent : Int!

Number of posts already sent on this day.

scheduled : Int!

Number of posts scheduled for this day.

limit : Int

The network daily posting limit. Null means unlimited.

isAtLimit : Boolean!

Whether the channel has reached its daily posting limit.

TYPE

DeletePostSuccess

deletePost success response returns the post id that was deleted.

Fields 1

id : PostId!

Post id that was delete.

TYPE

DocumentAsset

Document asset

Implements: Asset

Fields 6

id : ID

The ID of the asset in the database

type : AssetType!

The type of the asset

mimeType : String!

The MIME type of the asset

source : String!

URL to the file source

thumbnail : String!

URL to the static thumbnail of the asset

document : DocumentMetadata!

Document specific metadata

TYPE

Idea

Ideas are the main entity in the create space

Fields 7

id : ID!

Unique identifier for the idea

organizationId : ID!

ID of the organization that owns this idea

content : IdeaContent!

The actual content and metadata of the idea

groupId : ID

ID of the group this idea belongs to (if any)

position : Float

Numerical position for ordering within a group

createdAt : Int!

Unix timestamp of when the idea was created

updatedAt : Int!

Unix timestamp of when the idea was last modified

TYPE

IdeaContent

Content of an idea

Fields 7

title : String

Title or headline of the idea

text : String

Main body text or description of the idea

media : [IdeaMedia!]

List of media items attached to the idea

tags : [PublishingTag!]!

Tags used to categorize and organize the idea

aiAssisted : Boolean!

Indicates whether AI tools were used in creating this idea

services : [Service!]!

Services tagged by the user - this is typically used to annotate ideas with their target services

date : DateTime

DateTime set by user associated with the idea - this often reflects a target publish date.

TYPE

IdeaMedia

Media attached to an idea

Fields 7

id : ID!

Unique identifier for the media in Buffer's upload system

url : String!

Direct URL to access the media file

alt : String

Alternative text description for accessibility

thumbnailUrl : String

URL to a smaller version of the media for preview purposes

type : MediaType!

Type of media (e.g., image, video, gif)

size : Int

File size in bytes

source : IdeaMediaSource

Source platform information for the media

TYPE

IdeaMediaSource

Media source for the idea, e.g. Unsplash, Gifphy, etc.

Fields 4

name : String!

Name of the media source platform (e.g., 'Unsplash', 'Giphy')

id : String

Unique identifier from the source platform

author : String

Name of the content creator/author

authorUrl : String

URL to the author's profile on the source platform

TYPE

IdeaResponse

createIdea response type

Fields 2

idea : Idea

The affected idea

refreshIdeas : Boolean!

If true, the client should refresh the ideas list because other ideas might have been moved

TYPE

ImageAsset

Image asset

Implements: Asset

Fields 6

id : ID

The ID of the asset in the database

type : AssetType!

The type of the asset

mimeType : String!

The MIME type of the asset

source : String!

URL to the file source

thumbnail : String!

URL to the static thumbnail of the asset

image : ImageMetadata!

Image specific metadata

TYPE

InstagramGeolocation

Instagram Geolocation

Fields 2

id : String

The id of this location

text : String

The name of this location

TYPE

InstagramStickerFields

Instagram fields for reminder-based publishing. Upon the reminder for publishing, the user is prompted to copy and paste these fields into the Instagram app to complete the post.

Fields 5

text : String

Text for the Story or Reel

music : String

Placeholder text for the post's music

products : String

Placeholder text for the post's linked products

topics : String

Placeholder text for the post's topics (Reels only)

other : String

Additional field for any other post content

TYPE

InvalidInputError

Error returned when the input is invalid

Implements: MutationError

Fields 1

message : String!

Error message

TYPE

LimitReachedError

Error returned when the limit is reached

Implements: MutationError

Fields 1

message : String!

Error message

TYPE

LinkAttachment

Link attachment

Implements: ScrapedLink

Fields 6

url : String!

URL that the link asset has been built from

expandedUrl : String

Full URL that the link asset has been built from

text : String!

Description for the scraped link

thumbnails : [String!]!

Thumbnails of media available in the link

thumbnail : String

Selected thumbnail for this link preview

title : String!

Title for the link attachment

TYPE

LinkShorteningConfig

Link Shortening Configuration

Fields 2

domain : String!

Domain of the link shortener - eg buff.ly, dub.co, or the user's custom domain.

name : String!

Human readable string to describe the link shortening service.

TYPE

LocationData

Location data about the channel

Fields 3

location : String

Location of the business associated with the channel

googleAccountId : String

Google Account Id of the business

TYPE

MemberConnection

Represents the members connection edge. Later, we can add the list of members with the page info to follow our connection edge pattern.

Fields 1

totalCount : Int!

The total count of team members counting the org owner and team members from the Publish DB.

TYPE

Note

Note entity

Fields 7

id : NoteId!

The unique identifier of the note.

text : String!

The content of the note.

type : NoteType!

The type of the note.

author : Author!

The author of the note - null if the user is deleted or left the organization.

createdAt : DateTime!

The date and time when the note was created.

updatedAt : DateTime

The date and time when the note was last edited.

allowedActions : [NoteAction!]!

The allowed actions a user can perform on the note.

TYPE

NotFoundError

Error returned when the resource is not found

Implements: MutationError

Fields 1

message : String!

Error message

TYPE

Organization

Organization is a representation of a Buffer Organization.

Fields 7

id : OrganizationId!

The ID of the organization.

channelCount : Int!

The total number of channels connected to the organization.

limits : OrganizationLimits!

The limits of the organization. Can be used to check if the organization has reached the limit of channels, members, etc.

members : MemberConnection!

The members of the organization. Can be used to check the total number of members in the organization. In the future, it might contain more information about the members.

name : String!

The name of the organization.

ownerEmail : String!

The owner email of the organization.

shouldEnforce2FASetup : Boolean!

Whether the requesting actor should be sent through 2FA setup before they can use this organization. Derived: true only when the org has settings.enforce2FA ON, the organization-enforced-2fa rollout Split is ON for the org, and the actor has no 2FA configured on their own account.

This is the single source of truth for the forced-2FA gate; app-shell and publish-frontend redirect to the setup flow when it's true. Exposed to the API gateway so any stitched consumer reads the same value.

TYPE

OrganizationLimits

Resource limits for an organization including channels, members, and content limits

Fields 10

channels : Int!
No description provided.
members : Int!
No description provided.
scheduledPosts : Int!
No description provided.
scheduledStoriesPerChannel : Int!
No description provided.
generateContent : Int!
No description provided.
tags : Int!
No description provided.
ideas : Int!
No description provided.
ideaGroups : Int!
No description provided.
savedReplies : Int!
No description provided.
TYPE

PaginationPageInfo

Information to aid in pagination.

Fields 4

startCursor : String

The first cursor in the list. It can be used to fetch the previous page.

endCursor : String

The last cursor in the list. It can be used to fetch the next page.

hasPreviousPage : Boolean!

When set to true, it means there is a previous page available. Will always return false for now as we only support forward pagination.

hasNextPage : Boolean!

When set to true, it means there is a next page available.

TYPE

PinterestBoard

A Pinterest board

Fields 6

id : String!

The ID of the board

serviceId : String!

The ID of the service

name : String!

The board name

url : String!

The board URL

description : String

The board description

avatar : String

The board avatar

TYPE

Post

Post entity

Fields 27

id : PostId!

ObjectId of the post

ideaId : IdeaId

Is set when the Post is generated from an Idea

status : PostStatus!

status

via : PostVia!

Indicates if the post is created from Buffer or the API

schedulingType : SchedulingType

Scheduling type can be null if the post was created natively on the social network without using notification publishing or automatic publishing

author : Author

Represents the user who created the post

isCustomScheduled : Boolean!

Indicates whether time to publish was manually selected by the user

createdAt : DateTime!

Date when the post was created

updatedAt : DateTime!

Date when the post was updated

dueAt : DateTime

Date when the post is scheduled to be published

sentAt : DateTime

Date when the post is published

text : String!

Text content of the Post

channelId : ChannelId!

channel ID (faster than resolving the channnel.id)

channelService : Service!

channel service (faster than resolving the channnel.service)

channel : Channel!

channel

tags : [Tag!]!

tags - sorted by name in ascending order

notes : [Note!]!

notes

notificationStatus : NotificationStatus

notificationStatus: notified or markedAsPublished

error : PostPublishingError

error

assets : [Asset!]!

assets

metrics : [PostMetric!] 🧪 Preview

Metrics for the sent post. If post is not yet sent, this field will be null

metricsUpdatedAt : DateTime 🧪 Preview

Timestamp of when metrics were last refreshed from the network. Null until the daily ingestion job has processed the post. Buffer pulls fresh metrics once per day, so this can lag the network value by ~24h.

allowedActions : [PostAction!]!

Indicates what actions the current account can perform on the post

sharedNow : Boolean!

Indicates whether the post was shared via publish now action

shareMode : ShareMode!

Indicates the share mode of the post (e.g., addToQueue, shareNext, shareNow, customScheduled)

TYPE

PostActionSuccess

Success response returns the full up-to-date post from after the action was performed.

Fields 1

post : Post!

Post on which the action was successfully performed.

TYPE

PostingGoal

Represents a posting goal for a channel, including target, progress, and status information.

Fields 6

goal : Int!

The target number of posts for this goal.

sentCount : Int!

The number of posts that have been sent (published or ingested) for this goal.

scheduledCount : Int!

The number of posts that are scheduled to be sent for this goal.

status : PostingGoalStatus!

The current status of the posting goal.

periodStart : DateTime!

The start date of the period for this posting goal.

periodEnd : DateTime!

The end date of the period for this posting goal.

TYPE 🧪 Preview

PostMetric

A single metric for a post (or an entry in an aggregated metrics response).

Fields 5

type : PostMetricType!

The type of metric. Cross-network metrics use unified naming (reactions, comments, etc.); network-specific metrics retain their network's vocabulary (saves, quotes, etc.). See PostMetricType for the full catalog including deprecated values.

name : String!

The human-readable name of the metric (e.g. "Reactions", "Eng. Rate").

description : String!

A human-readable description of what the metric represents.

value : Float!

The metric value. Defaults to 0 when the network did not report the metric.

unit : PostMetricUnit!

The unit (count vs percentage) of value.

TYPE

PostPublishingError

Post publishing error

Fields 3

message : String!

Error message to display

supportUrl : String

Link to a help center article to help resolve the error

rawError : String

The original error from the publishing service (internal use only)

TYPE

PostsEdge

Represent a node in the pagination result using the Connect Relay convention.

Fields 2

node : Post!

Represents the current post in the list.

cursor : String!

Opaque cursor to be used in pagination to fetch from current node.

TYPE

PostsResults

Results for the posts query.

Fields 2

edges : [PostsEdge!]

The list of posts that match the query.

pageInfo : PaginationPageInfo!

Information to aid in pagination.

TYPE

Preferences

Account preferences

Fields 3

timeFormat : String
No description provided.
startOfWeek : String
No description provided.
defaultScheduleOption : ScheduleOption!
No description provided.
TYPE

PublishingTag

Tag associated with a post

Fields 3

id : ID!
No description provided.
color : String!

Hex color for tag e.g #F523F1

name : String!
No description provided.
TYPE

RestProxyError

Error proxied from the REST API response

Implements: MutationError

Fields 3

message : String!

An error message from the REST API response that we proxied here

code : Int

Error code from the REST API response - https://buffer.com/developers/api/errors

TYPE

ScheduleV2

Posting schedule for a specific day of the week

Fields 3

day : DayOfWeek!

The day of the week: mon, tue, wed, thu, fri, sat, sun

times : [String!]!

The times the channel is scheduled to post on the day: HH:MM

paused : Boolean!

Indicates if this day is paused in the posting schedule.

TYPE

Tag

Tag entity

Fields 4

id : TagId!

ObjectId of the tag

color : String!

Hex color for tag e.g '#F523F1'

name : String!

Name of the tag e.g 'Summer sales'

isLocked : Boolean!

Locked tag cannot be assigned to new items in the UI. A Tag is locked after a customer downgrades and has more tags than the free plan limit allows

TYPE

UnauthorizedError

Error returned when the user is not authorized to perform the action

Implements: MutationError

Fields 1

message : String!

Error message

TYPE

UnexpectedError

Error returned when unexpected error occurs

Implements: MutationError

Fields 1

message : String!

Error message

TYPE

UserTag

User tag in the image

Fields 3

handle : String!

The handle (username) of the tagged account, without the leading @.

x : Float!

Horizontal position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image width from the left edge (0.5 is the horizontal center).

y : Float!

Vertical position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image height from the top edge (0.5 is the vertical center).

TYPE

VideoAsset

Video asset

Implements: Asset

Fields 6

id : ID

The ID of the asset in the database

type : AssetType!

The type of the asset

mimeType : String!

The MIME type of the asset

source : String!

URL to the file source

thumbnail : String!

URL to the static thumbnail of the asset

video : VideoMetadata!

Video specific metadata

TYPE

VoidMutationError

Error implementation that allows clients to resolve the MutationError on mutations that do not currently have typed errors. This allows clients to automatically handle errors that may be added to a mutation in future.

Do not directly throw this error, use a custom typed error instead

Implements: MutationError

Fields 1

message : String!

Error message

TYPE

WeeklyPostingLimit

Weekly posting limit for a channel

Fields 3

sent : Int!

The number of posts the channel has sent this week

scheduled : Int!

The number of posts the channel has scheduled for this week

limit : Int!

The weekly posting limit for the channel

TYPE

YoutubeCategory

Fields 2

categoryId : String!
No description provided.
title : String!
No description provided.
INPUT 🧪 Preview

AggregatedPostMetricsInput

Input for the aggregatedPostMetrics query.

Fields 5

organizationId : OrganizationId!

The organization ID

startDateTime : DateTime!

Start of the aggregation window. Consumers typically pass UTC midnight of the first calendar day in the window, for example 2026-01-01T00:00:00Z.

endDateTime : DateTime!

End of the aggregation window. Consumers typically pass UTC midnight of the last calendar day in the window (the backend treats the range as inclusive of that day), for example 2026-01-31T00:00:00Z. Date range is capped to 365 days.

channelIds : [ChannelId!]

Optional list of channel IDs to filter by. When omitted (null), the aggregate spans every channel in the organization the actor has insights access to. When set to an empty array, no channels match and the result is empty.

tags : TagComparator

Filter to posts with specific tags. When omitted, all posts are included regardless of tags.

INPUT

AnnotationInputFacebook

Annotation representing all the entities in the text

Fields 4

content : String!

The content of the annotation, e.g. '107509875938399'

indices : [Int!]!

The indices of the annotation in the text, e.g. [6, 9] (from 6 to 9 characters in the text)

text : String!

The text representation of the annotation, eg 'Buffer'

url : String!

The URL the annotation points to, e.g. https://www.facebook.com/107509875938399

INPUT

AnnotationInputLinkedIn

Annotation representing all the entities in the text

Fields 7

id : String!

The id of the annotation, e.g. 1521226

entity : String!

The entity of the annotation, e.g. urn:li:organization:1521226

vanityName : String!

The vanity name of the annotation, e.g. bufferapp

localizedName : String!

The localized name of the annotation, e.g. Buffer

start : Int!

The start of the annotation, e.g. 5

length : Int!

The length of the annotation, e.g. 6

INPUT

AssetInput

A single entity's asset. Exactly one variant must be provided.

Fields 4

image : ImageAssetInput

Image asset

video : VideoAssetInput

Video asset

document : DocumentAssetInput

Document asset

INPUT

ChannelInput

Input for the channel query

Fields 1

id : ChannelId!

The ID of the channel to be retrieved

INPUT

ChannelsFiltersInput

Filter to pass when fetching channels.

Fields 2

isLocked : Boolean

If not defined, it returns all channels Else, if true, it only returns locked channels if false, it only returns not locked channels

product : Product

If not passed, it return all channels Else, it filters the channels based on what the product supports.

INPUT

ChannelsInput

Input to pass when fetching channels.

Fields 2

organizationId : OrganizationId!

The Organization id to fetch channels for

filter : ChannelsFiltersInput

A list of option filters - passing null means we don't want to filter

INPUT

CreateIdeaInput

createIdea input type

Fields 5

organizationId : ID!

Organization ID that will own the idea

content : IdeaContentInput!

Content and metadata for the new idea

cta : String

Call-to-action identifier for analytics tracking

group : IdeaGroupInput

Group placement (null for unassigned group)

templateId : String

Template ID used to create the idea

INPUT

CreatePostInput

Create post's request input.

Note: assets.videos and metadata.{service}.linkAttachment are mutually exclusive. If both are provided, the video is ignored.

Fields 13

ideaId : IdeaId

Is set when the Post is generated from an Idea

draftId : DraftId

Is set when the Post is generated from a Draft

schedulingType : SchedulingType!

Scheduling type to indicate notification publishing or automatic publishing

dueAt : DateTime

Date when the post is scheduled to be published

text : String

Text content of the Post.

Note: for threaded posts, this needs to match the first item in the thread array.

channelId : ChannelId!

Channel's Id for which we want to create the post

tagIds : [TagId!]

List of tag IDs

assets : [AssetInput!]!

Ordered list of assets on this post.

mode : ShareMode!

How the post is being scheduled.

source : String

source where the composer was initiated from, used for tracking.

aiAssisted : Boolean

If this post was created with the help of AI

saveToDraft : Boolean

If true, saves the post as a draft instead of scheduling it. When saving as draft:

  • Post status will be 'draft' instead of 'buffer'
  • Posting limits are not checked
  • The post will not be published until explicitly scheduled
INPUT

DailyPostingLimitsInput

Input for the dailyPostingLimits query.

Fields 2

channelIds : [ChannelId!]!

List of channel IDs to check limits for. All channels must belong to the same organization.

date : DateTime

The date to check limits for. Defaults to today if not provided.

INPUT

DateTimeComparator

Comparator for filtering by date

Fields 2

start : DateTime

Include results with dates equal to or after the specified date

end : DateTime

Include results with dates equal to or before the specified date

INPUT

DeletePostInput

deletePost mutation deletes a post by id.

Fields 1

id : PostId!

Post id to delete.

INPUT

DocumentAssetInput

Document asset

Fields 3

url : String!

Document URL

title : String!

Document title

thumbnailUrl : String!

Document thumbnail URL

INPUT

EditPostInput

Edit post's request input.

Note: assets.videos and metadata.{service}.linkAttachment are mutually exclusive. If both are provided, the video is ignored.

Fields 13

id : PostId!

ID of the post to edit

ideaId : IdeaId

Is set when the Post is generated from an Idea

draftId : DraftId

Is set when the Post is generated from a Draft

schedulingType : SchedulingType!

Scheduling type to indicate notification publishing or automatic publishing

dueAt : DateTime

Date when the post is scheduled to be published

text : String

Text content of the Post.

Note: for threaded posts, this needs to match the first item in the thread array.

tagIds : [TagId!]

tags

assets : [AssetInput!]

Ordered list of assets on this post. Omit to preserve the existing list, pass an empty array to clear it

mode : ShareMode!

How the post is being scheduled.

source : String

source where the composer was initiated from, used for tracking.

aiAssisted : Boolean

If this post was edited with the help of AI

saveToDraft : Boolean

If true, saves the post as a draft instead of keeping it scheduled. When saving as draft:

  • Post status will be 'draft' instead of 'buffer'
  • The post will not be published until explicitly scheduled
INPUT

IdeaContentInput

content input for creating/updating an idea

Fields 7

title : String

Title or headline of the idea

text : String

Main body text or description

media : [IdeaMediaInput!]

List of media items to attach

tags : [TagInput!]

Tags to categorize the idea

aiAssisted : Boolean

Whether AI tools were used in creation

services : [Service!]

Services associated with the idea for targeting specific platforms

date : DateTime

Target date for the idea, often used for planning publish schedules

INPUT

IdeaGroupInput

idea group input for create/update

Fields 2

groupId : ID

Target group ID (null for unassigned group)

placeAfterId : ID

ID of idea to place after (null for top position)

INPUT

IdeaMediaInput

Fields 6

url : String!

The URL of the media

alt : String

Alternative text for the media

thumbnailUrl : String

Thumbnail URL for the media

type : MediaType!

The type of media (image, gif, video, link, document, unsupported). Note: 'video' is not supported via public API

size : Int

The size of the media in bytes

source : IdeaMediaSourceInput

Source information for the media

INPUT

IdeaMediaSourceInput

Input type for the source information of media attached to an idea

Fields 5

name : String!
No description provided.
id : String
No description provided.
trigger : String
No description provided.
author : String

for unsplash only

authorUrl : String
No description provided.
INPUT

ImageAssetInput

Image asset

Fields 3

url : String!

URL to the file source

thumbnailUrl : String

URL to the static thumbnail of the asset

INPUT

ImageDimensionsInput

Image dimensions

Fields 2

width : Int!

Image width in pixels

height : Int!

Image height in pixels

INPUT

InstagramGeolocationInput

Instagram Geolocation

Fields 2

id : String

The id of this location

text : String

The name of this location

INPUT

InstagramStickerFieldsInput

Instagram fields for reminder-based publishing. Upon the reminder for publishing, the user is prompted to copy and paste these fields into the Instagram app to complete the post.

Fields 5

text : String

Text for the Story or Reel

music : String

Placeholder text for the post's music

products : String

Placeholder text for the post's linked products

topics : String

Placeholder text for the post's topics (Reels only)

other : String

Additional field for any other post content

INPUT

LinkAssetInput

Link attached to the post

Fields 4

url : String!

URL to the link

title : String

Title of the link

description : String

Description of the link

thumbnailUrl : String

Thumbnail URL of the link

INPUT

LinkAttachmentInput

Link attachment

Fields 1

url : String!

URL that the link asset has been built from

INPUT

OrganizationFilterInput

Allow retrieving a specific Organization

Fields 1

organizationId : String!
No description provided.
INPUT

PostInput

Input for the post query

Fields 1

id : PostId!

The ID of the post to be retrieved

INPUT

PostsFiltersInput

Filter to apply to the posts query

Fields 8

channelIds : [ChannelId!]

When set, it will filter posts by channel

startDate : DateTime

When set, it will return posts with createdAt or dueAt date after startDate

endDate : DateTime

When set, it will return posts with createdAt or dueAt date before endDate

status : [PostStatus!]

When set, it will filter posts by status

tags : TagComparator

Filter posts by tags. Supports specific tags, untagged posts, or union of both.

tagIds : [TagId!]

When set, it will filter posts by tag

dueAt : DateTimeComparator

When set, it will filter posts by their scheduled posting date

createdAt : DateTimeComparator

When set, it will filter posts by the date they were created

INPUT

PostsInput

Input for the posts query

Fields 3

organizationId : OrganizationId!

The Organization id to fetch posts for

filter : PostsFiltersInput

The filters to apply to the posts query

sort : [PostSortInput!]

The sort to apply to the posts results

INPUT

PostSortInput

Sort order of post results. List multiple to create tie-breaking order.

Fields 2

field : PostSortableKey!

The field to sort by.

direction : SortDirection!

The direction to sort by.

INPUT

TagComparator

Comparator for filtering by tags

Fields 2

in : [TagId!]!

Include results that have any of the specified tags (union/OR).

isEmpty : Boolean!

When true, include results that have no tags assigned. Can be combined with 'in' for union filtering. Defaults to false if not specified.

INPUT

TagInput

Input type for tag information used in idea creation

Fields 3

id : ID!
No description provided.
name : String!
No description provided.
color : String!
No description provided.
INPUT

UserTagInput

User tag in the image

Fields 3

handle : String!

The handle (username) of the account to tag, without the leading @.

x : Float!

Horizontal position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image width from the left edge (0.5 is the horizontal center). Pass a number, not a string, and do not use pixel coordinates; to convert, divide the pixel X by the image width.

y : Float!

Vertical position of the tag as a normalized decimal float between 0.0 and 1.0 - the fraction of the image height from the top edge (0.5 is the vertical center). Pass a number, not a string, and do not use pixel coordinates; to convert, divide the pixel Y by the image height.

INPUT

VideoAssetInput

Video asset

Fields 3

url : String!

URL to the file source

thumbnailUrl : String

URL to the thumbnail of the video

ENUM

AnnotationType

List of possible types for an annotation

Values 5

hashtag
mention
url
annotation
cashtag
ENUM

AssetType

Asset types

Values 3

image
video
document
ENUM

ChannelAction

List of possible actions that can be performed on a Channel

Values 13

backfillChannel
managePostingSchedule
publishStartPage
reconnectChannel
removeChannel
viewChannel
viewCapabilities
manageCapabilities
viewInsights
viewUpdates
manageUpdates
viewComments
manageComments
ENUM

ChannelType

Channel is a representation of a social media account or page that can be connected to Buffer.

Values 6

page
profile
business
group
account
channel
ENUM

DayOfWeek

Values 7

mon
tue
wed
thu
fri
sat
sun
ENUM

GoogleBusinessPostActionType

List of possible types for GBP cta

Values 7

none
book
order
shop
learn_more
signup
call
ENUM

MediaType

The type of media attached to a post

Values 6

image
gif
video
link
document
unsupported
ENUM

NoteAction

List of possible actions that can be performed on a note

Values 2

updateNote The user can update the note.
deleteNote The user can delete the note.
ENUM

NoteType

The type of a note.

Values 3

userGenerated A note that was manually written by a user.
bufferGenerated A note that was generated by our internal system. Can be used for approval flows notifications or other automated processes.
aiGenerated A note that was generated by our AI system.
ENUM

NotificationStatus

List of possible statuses for a notification

Values 2

notified
markedAsPublished
ENUM

OrganizationAction

List of possible actions that can be performed on a Organization

Values 13

view
createPostTemplate
edit
manageBilling
manageTeamMembers
publishStartPages
manageAllNotes
manageChannels
manageChannelGroups
transferOwnership
receiveOrganizationOwnership
manageSecurityTFAEnforcement
manageTrustedPartnerStatus
ENUM

PostAction

List of possible actions that can be performed on a Post

Values 22

updatePost
deletePost
viewPost
sharePostLink
copyPostLink
movePostToDraft
publishPostNow
publishPostNext
addPostToQueue
updatePostSchedule
removePostScheduledTime
requestPostApproval
revertPostApprovalRequest
approvePost
rejectPost
duplicatePost
updatePostTags
addPostNote
updateShopGridLink
createPostRecurrence
editPostRecurrence
cancelPostRecurrence
ENUM

PostingGoalStatus

PostingGoalStatus is used to track the status of a posting goal.

Values 3

OnTrack
AtRisk
Hit
ENUM 🧪 Preview

PostMetricType

List of possible metrics available for a Post.

Values fall into three groups:

  • Cross-network normalized (reactions, comments, shares, reposts, reach, impressions, views, clicks, engagementRate): Used wherever a concept maps cleanly across networks. Per-network adapters normalize their native names (e.g., Instagram likes → reactions, Twitter retweets → reposts).
  • Network-specific (saves, follows, quotes, viewers, totalTimeWatched, likes): Real metrics that don't have a cross-network equivalent. likes is intentionally distinct from reactions on Facebook — Facebook's Graph API surfaces them separately.
  • Aggregation-only (postCount): Meaningful only on aggregate endpoints; never emitted per-post.

Deprecated values are pre-normalization legacy or tied to features being removed. They're kept in the enum for backwards compatibility until clients migrate.

Values 23

reactions How many people reacted to your post. Unified across networks: Instagram/Twitter `likes`, Mastodon `favorites`, etc. all map to this value.
comments The count of comments and replies on your post. Unified across networks (Threads `replies` maps here).
shares How many times your post was shared or forwarded by others.
reposts How many times your post was reposted by others. Twitter `retweets`, Mastodon `reblogs`, Threads `reposts` all normalize to this value.
reach The number of unique people who saw your post.
impressions How many times your post was shown on screen. May include multiple views by the same person — useful for spotting how often the content gets surfaced.
views How many times your post was viewed. Used for video-style posts and on networks that report views distinctly from impressions.
clicks How many times people clicked on your post.
engagementRate The percentage of people who interacted with your post compared to how many saw it. Unit: percentage.
saves How many times people saved your post (Instagram, Pinterest). A strong signal that the content is worth revisiting.
follows The number of new followers gained from this post (Instagram).
quotes How many times your post was quoted (Threads).
viewers Unique viewer count for video-style posts (LinkedIn).
totalTimeWatched Total time watched, in minutes, for video-style posts (LinkedIn).
likes The Like-reaction subcount on Facebook. Distinct from `reactions` (which is the total of all reaction types — Like, Love, Care, Haha, Wow, Sad, Angry); Facebook's Graph API reports them separately and we mirror that.
postCount The count of posts included in an aggregated response. Only meaningful on aggregate endpoints — never emitted per-post.
replies Deprecated: not emitted by any per-network definition. Use `comments` instead — replies are normalized into `comments` on the networks that distinguish them (Threads). Will be removed on 2026-12-01. Deprecated: Not emitted by any per-network definition; use `comments` instead. Will be removed on 2026-12-01.
favorites Deprecated: not emitted by any per-network definition. Use `reactions` instead — Twitter and Mastodon favorites normalize into `reactions`. Will be removed on 2026-12-01. Deprecated: Not emitted by any per-network definition; use `reactions` instead. Will be removed on 2026-12-01.
reblogs Deprecated: not emitted by any per-network definition. Use `reposts` instead — Mastodon reblogs normalize into `reposts`. Will be removed on 2026-12-01. Deprecated: Not emitted by any per-network definition; use `reposts` instead. Will be removed on 2026-12-01.
retweets Deprecated: not emitted by any per-network definition. Use `reposts` instead — Twitter retweets normalize into `reposts`. Will be removed on 2026-12-01. Deprecated: Not emitted by any per-network definition; use `reposts` instead. Will be removed on 2026-12-01.
repins Deprecated: not emitted by any per-network definition. Pre-normalization legacy from the Pinterest era. Will be removed on 2026-12-01. Deprecated: Not emitted by any per-network definition. Will be removed on 2026-12-01.
link_clicks Deprecated: StartPage link-clicks metric. StartPage is being deprecated as a product. Will be removed on 2026-12-01. Deprecated: StartPage is being deprecated as a product. Will be removed on 2026-12-01.
other Deprecated catch-all from pre-normalization. Never emitted. Will be removed on 2026-12-01. Deprecated: Catch-all from pre-normalization; never emitted. Will be removed on 2026-12-01.
ENUM 🧪 Preview

PostMetricUnit

The unit representing the value of a PostMetric.

Values 2

count An integer count (e.g. number of reactions, impressions, reach).
percentage A percentage value between 0 and 100 (e.g. engagement rate).
ENUM

PostSortableKey

Key of collection to use for sorting

Values 2

dueAt Sort by the post's dueAt field. Due at is the date when the post is scheduled to be published.
createdAt Sort by the post's createdAt field. Created at is the date when the post was created.
ENUM

PostStatus

List of possible statuses for a Post

Values 6

draft
needs_approval
scheduled
sending
sent
error
ENUM

PostType

List of possible types for a Post. Some services may have different types (e.g., Instagram has story, reel, post but Twitter has only post)

Values 10

post
reel
story
short
whats_new
offer
event
carousel
ghost_post
thread
ENUM

PostTypeFacebook

List of specific post types available for Facebook

Values 3

post
story
reel
ENUM

PostTypeGoogleBusiness

List of specific post types available for Google Business profiles

Values 3

event
whats_new
offer
ENUM

PostVia

List of possible ways to create a Post

Values 3

buffer
network
api
ENUM

Product

Buffer products, buffer is used as all products

Values 6

analyze
engage
publish
buffer
startPage
comments
ENUM

ScheduleOption

Values 4

Queue
Prioritize
FixedTime
Now
ENUM

SchedulingType

Indicates whether the post was scheduled for notification publishing or automatic publishing

Values 2

notification The post was created natively on the social network using notification publishing
automatic The post was created natively on the social network using automatic publishing
ENUM

Service

The list of services that can be authorized.

Values 12

instagram
facebook
twitter
linkedin
pinterest
tiktok
googlebusiness
startPage
mastodon
youtube
threads
bluesky
ENUM

ShareMode

How the post is being scheduled.

Values 4

addToQueue
shareNow
shareNext
customScheduled
ENUM

SortDirection

Direction to sort the results by.

Values 2

asc Sort records in ascending order.
desc Sort records in descending order.
ENUM

YoutubeLicense

List of license types

Values 2

youtube
creativeCommon
ENUM

YoutubePrivacy

List of privacy types

Values 3

public
unlisted
private
INTERFACE

Asset

Asset interface with common fields

Fields 5

id : ID

The ID of the asset in the database

type : AssetType!

The type of the asset

mimeType : String!

The MIME type of the asset

source : String!

URL to the file source

thumbnail : String!

URL to the static thumbnail of the asset

INTERFACE

MutationError

Base Mutation Error type

Fields 1

message : String!

Error message

INTERFACE

ScrapedLink

Link data for link preview

Fields 3

url : String!

URL that the link asset has been built from

text : String!

Description for the scraped link

thumbnails : [String!]!

Thumbnails of media available in the link

UNION

GoogleBusinessPostDetails

GoogleBusiness Metadata details

Possible Types 3

GoogleBusinessWhatsNewMetaDataGoogleBusinessOfferMetaDataGoogleBusinessEventMetaData
SCALAR

AccountId

The AccountId scalar represents the MongoDB ObjectId of a Buffer Account

SCALAR

ChannelId

The ChannelId scalar represents the MongoDB ObjectId of a Buffer Channel

SCALAR

DateTime

The DateTime scalar represents a date and time following the ISO 8601 standard.

SCALAR

DraftId

The DraftId scalar represents the MongoDB ObjectId of a Buffer Draft

SCALAR

IdeaId

The IdeaId scalar represents the MongoDB ObjectId of a Buffer Idea

SCALAR

InvitationId

The InvitationId scalar represents the MongoDB ObjectId of a pending team invitation

SCALAR

NoteId

The NoteId scalar represents the MongoDB ObjectId of a Buffer Note

SCALAR

OrganizationId

The OrganizationId scalar represents the MongoDB ObjectId of a Buffer Organization

SCALAR

PostGroupId

The PostGroupId scalar represents the MongoDB ObjectId of a Buffer Post Group.

SCALAR

PostId

The PostId scalar represents the MongoDB ObjectId of a Buffer Post

SCALAR

TagId

The TagId scalar represents the MongoDB ObjectId of a Buffer Tag

SCALAR

Uuid

The Uuid scalar represents an RFC 4122 v4 UUID, e.g. 550e8400-e29b-41d4-a716-446655440000.