Buffer API

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 8

category : ConnectedAppCategory

The category of the connected app, when known.

clientId : ID!

The id of the connectedApp.

description : String!

A brief description of the connected app.

name : String!

The name of the connected app.

scopes : [String!]!

The access scopes granted to this connection for Buffer's public API resources. Empty when the connection holds none.

userId : ID!

The id of the user that has granted access to the 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 2

ENUM ConnectedAppCategory

The category of a connected app.

ENUM ScheduleOption

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"
      ],
      "avatar": "...",
      "descriptor": "..."
    }
  }
}

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"
        ],
        "avatar": "...",
        "descriptor": "..."
      }
    ]
  }
}

Mutations 1

MUTATION updatePostTemplate (input: UpdatePostTemplateInput!) : UpdatePostTemplatePayload! Preview

Update a post template owned by the caller (or an internal template in the caller's organization, if the caller is an org admin/owner).

Arguments

Name	Type	Description
input Required	UpdatePostTemplateInput!	Input for updating a post template.

Example Response

{
  "data": {
    "updatePostTemplate": {}
  }
}

Outputs 2

OUTPUT Channel

Channel entity

Fields 27

id : ChannelId!

The ID of the channel

allowedActions : [ChannelAction!]!

The allowed actions for the current user

avatar : String!

The avatar URL 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?)

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

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

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

isQueuePaused : Boolean!

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

linkShortening : ChannelLinkShortening!

Link Shortening settings for the channel

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

postingGoal : PostingGoal

The posting goal for the channel

postingSchedule : [ScheduleV2!]!

Provides the posting slots for each day of the week

products : [Product!]

Products that support a given channel

scopes : [String]!

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

service : Service!

Represents the social network

serviceId : String!

Represents the external ID of the channel on social network API

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.

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.

weeklyPostingLimit : WeeklyPostingLimit

Weekly posting limit for the channel

createdAt : DateTime!

The creation date of the channel

updatedAt : DateTime!

The last time the channel was updated

OUTPUT UpdatePostTemplatePayload Preview

Result of an end user updating a post template.

Types 18

TYPE BlueskyMetadata

Bluesky metadata

Fields 1

serverUrl : String!

The instance of bluesky of the channel

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 FacebookMetadata

Facebook metadata

Fields 1

locationData : LocationData

Metadata about the location of the business associated with the channel. Only available for Facebook and GPB

TYPE GoogleBusinessMetadata

Google Business metadata

Fields 1

locationData : LocationData

Metadata about the location of the business associated with the channel. Only available for Facebook and GPB

TYPE IdeaMedia

Media attached to an idea

Fields 7

id : ID!

Unique identifier for the media in Buffer's upload system

alt : String

Alternative text description for accessibility

size : Int

File size in bytes

source : IdeaMediaSource

Source platform information for the media

thumbnailUrl : String

URL to a smaller version of the media for preview purposes

type : MediaType!

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

url : String!

Direct URL to access the media file

TYPE IdeaMediaSource

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

Fields 4

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

name : String!

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

TYPE LinkedInMetadata

LinkedIn metadata

Fields 1

shouldShowLinkedinAnalyticsRefreshBanner : Boolean!

Property parsed from scopes indicating whether the client should show the LinkedIn analytics refresh banner

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

googleAccountId : String

Google Account Id of the business

location : String

Location of the business associated with the channel

mapsLink : String

Link to the map

TYPE MastodonMetadata

Mastodon metadata

Fields 2

maxCharacters : Int!

Maximum character limit allowed for this channel's server instance

serverUrl : String!

The instance of mastodon of the channel

TYPE PinterestBoard

A Pinterest board

Fields 6

id : String!

The ID of the board

avatar : String

The board avatar

description : String

The board description

name : String!

The board name

serviceId : String!

The ID of the service

url : String!

The board URL

TYPE PinterestMetadata

Pinterest metadata

Fields 1

boards : [PinterestBoard!]!

The list of boards the user has on Pinterest

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

paused : Boolean!

Indicates if this day is paused in the posting schedule.

times : [String!]!

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

TYPE TiktokMetadata

Tiktok metadata

Fields 1

defaultToReminders : Boolean!

Indicates if we should default to reminder for Tiktok

TYPE TwitterMetadata

Twitter metadata

Fields 1

subscriptionType : String

Indicates the type of subscription the user has on Twitter

TYPE UpdatePostTemplateSuccess Preview

Successful result of an end user updating a post template.

Fields 1

postTemplate : PostTemplate!

The updated post template.

TYPE YoutubeMetadata

Youtube metadata

Fields 1

defaultToReminders : Boolean!

Indicates if we should default to reminder for Youtube

TYPE ChannelMetadata

Metadata or settings about the channel depending on the service type

Inputs 6

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

filter : ChannelsFiltersInput

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

organizationId : OrganizationId!

The Organization id to fetch channels for

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

INPUT UpdatePostTemplateInput

Input for an end user updating a post template. Buffer-curated taxonomy fields are ignored; setting them is only available to official Buffer clients.

Fields 6

id : PostTemplateId!

The ID of the template to update.

body : String

The main content body of the template, may contain {{placeholders}}.

description : String

A short user-facing description of the template.

emoji : String

The emoji associated with the template.

title : String

The title of the template.

visibility : PostTemplateVisibility

`public` is rejected it is only available to official Buffer clients.

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

Day of the week.

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 6

QUERY aggregatedPostMetrics (input: AggregatedPostMetricsInput!) : AggregatedPostMetrics!

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": [
        {
          "description": "...",
          "name": "...",
          "type": "clicks",
          "unit": "count"
        }
      ],
      "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": "...",
        "isAtLimit": true,
        "limit": 0,
        "scheduled": 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": "...",
      "allowedActions": [
        "addPostNote"
      ],
      "assets": [
        {
          "id": "...",
          "mimeType": "...",
          "source": "...",
          "thumbnail": "..."
        }
      ],
      "author": {
        "id": "...",
        "avatar": "...",
        "email": "...",
        "isDeleted": true
      }
    }
  }
}

QUERY posts (after: String, first: Int, input: PostsInput!) : PostsResults!

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

Arguments

Name	Type	Description
after Optional	String	The cursor of the post to start fetching from
first Optional	Int	The number of posts to return
input Required	PostsInput!	Query's input.

Example Response

{
  "data": {
    "posts": {
      "edges": [
        {
          "cursor": "...",
          "node": {}
        }
      ],
      "pageInfo": {
        "endCursor": "...",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "..."
      }
    }
  }
}

QUERY postTemplate (input: PostTemplateInput!) : PostTemplate Preview

Fetch a single post template by ID. Returns null if not found.

Arguments

Name	Type	Description
input Required	PostTemplateInput!	Input for fetching a single post template.

Example Response

{
  "data": {
    "postTemplate": {
      "id": "...",
      "body": "...",
      "description": "...",
      "emoji": "..."
    }
  }
}

QUERY postTemplates (after: String, first: Int, input: PostTemplatesInput!) : PostTemplatesConnection! Preview

Fetch the templates visible to the current actor for the template library: public templates, plus internal templates from the supplied organizationId, plus private templates owned by the actor's account. The visibility scope is always pinned to the actor and the supplied organization the input filter can only narrow within that scope, never widen it.

Arguments

Name	Type	Description
after Optional	String	The cursor after which to return results.
first Optional	Int	The number of templates to return.
input Required	PostTemplatesInput!	Input containing the organization scope and optional filters.

Example Response

{
  "data": {
    "postTemplates": {
      "edges": [
        {
          "cursor": "...",
          "node": {}
        }
      ],
      "pageInfo": {
        "endCursor": "...",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "..."
      },
      "totalCount": 0
    }
  }
}

Mutations 6

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 createPostTemplate (input: CreatePostTemplateInput!) : CreatePostTemplatePayload! Preview

Create a post template visible only to the caller (private) or to the caller's organization (internal).

Arguments

Name	Type	Description
input Required	CreatePostTemplateInput!	Input for creating a post template.

Example Response

{
  "data": {
    "createPostTemplate": {}
  }
}

MUTATION deletePost (input: DeletePostInput!) : DeletePostPayload!

Delete a post by id.

Arguments

Name	Type	Description
input Required	DeletePostInput!	Input for the deletePost mutation.

Example Response

{
  "data": {
    "deletePost": {}
  }
}

MUTATION deletePostTemplate (input: DeletePostTemplateInput!) : DeletePostTemplatePayload! Preview

Delete a post template owned by the caller (or an internal template in the caller's organization, if the caller is an org admin/owner).

Arguments

Name	Type	Description
input Required	DeletePostTemplateInput!	Input for deleting a post template.

Example Response

{
  "data": {
    "deletePostTemplate": {}
  }
}

MUTATION editPost (input: EditPostInput!) : PostActionPayload!

Edit post for channel

Arguments

Name	Type	Description
input Required	EditPostInput!	The mutation's input

Example Response

{
  "data": {
    "editPost": {}
  }
}

MUTATION movePostInQueue (input: MovePostInQueueInput!) : MovePostInQueuePayload! Experimental

Move a queued post to the top or bottom of its channel's queue. Unlike editPost, this is a scheduling-only operation that never re-validates the post's content.

Arguments

Name	Type	Description
input Required	MovePostInQueueInput!	The mutation's input

Example Response

{
  "data": {
    "movePostInQueue": {}
  }
}

Outputs 11

OUTPUT 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.

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.

isAtLimit : Boolean!

Whether the channel has reached its daily posting limit.

limit : Int

The network daily posting limit. Null means unlimited.

scheduled : Int!

Number of posts scheduled for this day.

sent : Int!

Number of posts already sent on this day.

OUTPUT Post

Post entity

Fields 27

id : PostId!

ObjectId of the post

allowedActions : [PostAction!]!

Indicates what actions the current account can perform on the post

assets : [Asset!]!

assets

author : Author

Represents the user who created the post

channel : Channel!

channel

channelId : ChannelId!

channel ID (faster than resolving the channnel.id)

channelService : Service!

channel service (faster than resolving the channnel.service)

dueAt : DateTime

Date when the post is scheduled to be published

error : PostPublishingError

error

externalLink : String

The external URL of the post at the destination service

ideaId : IdeaId

Is set when the Post is generated from an Idea

isCustomScheduled : Boolean!

Indicates whether time to publish was manually selected by the user

metadata : PostMetadata

Metadata of the post which differs based on the social network/service @see post.metadata.graphql

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.

notes : [Note!]!

notes

notificationStatus : NotificationStatus

notificationStatus: notified or markedAsPublished

schedulingType : SchedulingType

How the post publishes: `notification` for a reminder that asks someone to publish it by hand, `automatic` for one the publishing workers send.

sentAt : DateTime

Date when the post is published

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)

status : PostStatus!

status

tags : [Tag!]!

tags - sorted by name in ascending order

text : String!

Text content of the Post

via : PostVia!

Indicates if the post is created from Buffer or the API

createdAt : DateTime!

Date when the post was created

updatedAt : DateTime!

Date when the post was updated

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.

OUTPUT PostTemplate

A post template used for content inspiration.

Fields 9

id : PostTemplateId!

The unique identifier for the template.

body : String!

The main content body of the template, may contain {{placeholders}}.

description : String!

A short user-facing description of the template.

emoji : String!

The emoji associated with the template.

organizationId : OrganizationId!

The organization that owns this template.

title : String!

The title of the template.

visibility : PostTemplateVisibility!

The visibility level of the template. `public` is returned for Buffer-managed templates.

createdAt : DateTime!

The date and time the template was created.

updatedAt : DateTime!

The date and time the template was last updated.

OUTPUT PostTemplatesConnection Preview

A paginated connection of post templates.

Fields 3

edges : [PostTemplateEdge!]!

The list of post template edges.

pageInfo : PaginationPageInfo!

Pagination information for the connection.

totalCount : Int!

The total number of templates matching the filters.

OUTPUT CreatePostTemplatePayload Preview

Result of an end user creating a post template.

OUTPUT DeletePostPayload

All possible response types for the deletePost mutation.

OUTPUT DeletePostTemplatePayload Preview

Result of an end user deleting a post template.

OUTPUT MovePostInQueuePayload Experimental

All possible response types that can be returned by movePostInQueue mutation.

OUTPUT PostActionPayload

Create post's request response payload.

Types 49

TYPE Annotation

Annotation representing all the entities in the text

Fields 5

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'

indices : [Int!]!

The indices of the annotation in the text

text : String!

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

type : AnnotationType!

The type of the annotation

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.

avatar : String!

The avatar URL of the author.

email : String!

The email address 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 BlueskyPostMetadata

Bluesky post metadata

Fields 5

annotations : [Annotation!]!

Annotations representing entities in the text

linkAttachment : LinkAttachment

Link attachment

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE CreatePostTemplateSuccess Preview

Successful result of an end user creating a post template.

Fields 1

postTemplate : PostTemplate!

The newly created post template.

TYPE DeletePostSuccess

deletePost success response returns the post id that was deleted.

Fields 1

id : PostId!

Post id that was delete.

TYPE EmptySuccess

Empty mutation success response used when client doesn't need any data back or simply needs to respond to a success or error.

Fields 1

_empty : String!

The value is always an empty string '' Note: GraphQL doesn't allow types with no fields, so we have to add this field

TYPE FacebookPostMetadata

Facebook post metadata

Fields 5

annotations : [Annotation!]!

Annotations representing entities in the text

firstComment : String

Facebook post's first comment

linkAttachment : LinkAttachment

Link attachment

title : String

Title of Facebook reel

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE GoogleBusinessEventMetaData

Metadata for a GBP post that is an event

Fields 8

button : GoogleBusinessPostActionType!

Action button

endDate : DateTime!

End date of the event

endTime : String

End time of the event

isFullDayEvent : Boolean!

Indicate whether the event has a start or end time.

link : String

Link to the action

startDate : DateTime!

Start date of the event

startTime : String

Start time of the event

title : String!

Title of the event

TYPE GoogleBusinessOfferMetaData

Metadata for a GBP post that is an offer

Fields 6

code : String

Coupon code for the offer

endDate : DateTime!

End date of the offer

link : String

Link to the offer

startDate : DateTime!

Start date of the offer

terms : String

Terms and Conditions

title : String!

Title of the offer

TYPE GoogleBusinessPostMetadata

Google Business Profile post metadata @deprecated: pending proposal for specific GBP post types: update, offer and event metadata types

Fields 4

annotations : [Annotation!]!

Annotations representing entities in the text

details : GoogleBusinessPostDetails

Details of the metadata

title : String

Title if available in the given GBP post type: event and offer

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE GoogleBusinessWhatsNewMetaData

Metadata for a GBP post of type Whats new

Fields 2

button : GoogleBusinessPostActionType!

Action button

link : String

Link to the action

TYPE InstagramGeolocation

Instagram Geolocation

Fields 2

id : String

The id of this location

text : String

The name of this location

TYPE InstagramMetadata

Instagram metadata

Fields 1

defaultToReminders : Boolean!

Indicates if we should default to reminder for Instagram

TYPE InstagramPostMetadata

Instagram post metadata

Fields 8

annotations : [Annotation!]!

Annotations representing entities in the text

firstComment : String

Instagram post's first comment

geolocation : InstagramGeolocation

Geolocation of the post

isAiGenerated : Boolean!

Whether the post discloses AI-generated content

link : String

Shop Grid link for the post

shouldShareToFeed : Boolean!

Indicates whether post should be shared to feed

stickerFields : InstagramStickerFields

Sticker fields for reminder-based publishing

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

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

music : String

Placeholder text for the post's music

other : String

Additional field for any other post content

products : String

Placeholder text for the post's linked products

text : String

Text for the Story or Reel

topics : String

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

TYPE LinkAttachment

Link attachment

Fields 6

expandedUrl : String

Full URL that the link asset has been built from

text : String!

Description for the scraped link

thumbnail : String

Selected thumbnail for this link preview

thumbnails : [String!]!

Thumbnails of media available in the link

title : String!

Title for the link attachment

url : String!

URL that the link asset has been built from

TYPE LinkedInPostMetadata

LinkedIn post metadata

Fields 4

annotations : [Annotation!]!

Annotations representing entities in the text

firstComment : String

LinkedIn post's first comment

linkAttachment : LinkAttachment

Link attachment

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE MastodonPostMetadata

Mastodon post metadata

Fields 5

annotations : [Annotation!]!

Annotations representing entities in the text

spoilerText : String

Spoiler text hiding the root text of this post

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE Note

Note entity

Fields 7

id : NoteId!

The unique identifier of the note.

allowedActions : [NoteAction!]!

The allowed actions a user can perform on the note.

author : Author!

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

text : String!

The content of the note.

type : NoteType!

The type of the note.

createdAt : DateTime!

The date and time when the note was created.

updatedAt : DateTime

The date and time when the note was last edited.

TYPE NotFoundError

Error returned when the resource is not found

Fields 1

message : String!

Error message

TYPE PinterestPostMetadata

Pinterest post metadata

Fields 5

annotations : [Annotation!]!

Annotations representing entities in the text

board : PinterestBoard

The board the Pin is saved to

title : String

The title of the Pin

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

url : String

The Pin destination link

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.

periodEnd : DateTime!

The end date of the period for this posting goal.

periodStart : DateTime!

The start date of the period for this posting goal.

scheduledCount : Int!

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

sentCount : Int!

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

status : PostingGoalStatus!

The current status of the posting goal.

TYPE PostMetric

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

Fields 5

description : String!

A human-readable description of what the metric represents.

name : String!

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

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.

unit : PostMetricUnit!

The unit (count vs percentage) of `value`.

value : Float!

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

TYPE PostPublishingError

Post publishing error

Fields 3

message : String!

Error message to display

rawError : String

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

supportUrl : String

Link to a help center article to help resolve the error

TYPE PostsEdge

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

Fields 2

cursor : String!

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

node : Post!

Represents the current post in the list.

TYPE PostTemplateEdge Preview

An edge in a post template connection.

Fields 2

cursor : String!

A cursor for pagination.

node : PostTemplate!

The post template node at the end of the edge.

TYPE PublishingTag

Tag snapshot associated with content

Fields 4

id : ID!

color : String!

Hex color for tag e.g #F523F1

colorName : TagColorName

Stable Buffer palette identifier derived from `color`. Clients should map this value to platform- and theme-specific presentation, falling back to `color` when this field is null or unsupported. Returns null for custom or unrecognized colors.

name : String!

TYPE RestProxyError

Error proxied from the REST API response

Fields 3

code : Int

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

link : String

Link to our Help center from the REST API response

message : String!

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

TYPE RetweetMetadata

Information about the initial Tweet that was retweeted

Fields 6

id : String!

Retweet ID

text : String!

Text of the original tweet

thumbnails : [String!]!

Thumbnails to media available in the link

url : String!

Link to original tweet

user : RetweetUserMetadata!

User who created the original tweet

createdAt : DateTime!

Date when the original tweet was created

TYPE RetweetUserMetadata

Information about the initial author of the Tweet that was retweeted

Fields 3

avatar : String!

Avatar of the user who created the original Tweet

name : String!

Name of the user who created the original Tweet

username : String!

Username of the user who created the original Tweet

TYPE Tag

Tag entity

Fields 5

id : TagId!

ObjectId of the tag

color : String!

Hex color for tag e.g '#F523F1'

colorName : TagColorName

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

name : String!

Name of the tag e.g 'Summer sales'

TYPE ThreadedPost

Fields 4

assets : [Asset!]!

Media assets of the threaded post

linkAttachment : LinkAttachment

Use metadata.{service}.linkAttachment on the thread item instead. This field will be removed on December 15, 2026.

metadata : ThreadItemMetadata

Service-specific fields for this threaded post

text : String!

The text body content of the threaded post

TYPE ThreadItemBlueskyMetadata

Bluesky fields on a single item of a thread

Fields 1

linkAttachment : LinkAttachment

Link attachment

TYPE ThreadItemMetadata

Service-specific fields on a single item of a thread. The populated key matches the post's service.

Fields 2

bluesky : ThreadItemBlueskyMetadata

Bluesky fields for this thread item

threads : ThreadItemThreadsMetadata

Threads fields for this thread item

TYPE ThreadItemThreadsMetadata

Threads fields on a single item of a thread

Fields 1

linkAttachment : LinkAttachment

Link attachment

TYPE ThreadsPostMetadata

Threads post metadata

Fields 8

annotations : [Annotation!]!

Annotations representing entities in the text

linkAttachment : LinkAttachment

Link attachment

locationId : String

LocationId associated with the post

locationName : String

Location name associated with the post

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

topic : String

Topic associated with the post

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE TiktokPostMetadata

Tiktok post metadata

Fields 4

annotations : [Annotation!]!

Annotations representing entities in the text

isAiGenerated : Boolean!

Whether the post discloses AI-generated content (TikTok video only)

title : String

The title of the TikTok post (for photo posts)

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE TwitterPostMetadata

Twitter post metadata

Fields 6

annotations : [Annotation!]!

Annotations representing entities in the text

isAiGenerated : Boolean!

Whether the post discloses AI-generated content

retweet : RetweetMetadata

The details of the tweet being retweeted

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

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

limit : Int!

The weekly posting limit for the channel

scheduled : Int!

The number of posts the channel has scheduled for this week

sent : Int!

The number of posts the channel has sent this week

TYPE YoutubeCategory

Fields 2

categoryId : String!

title : String!

TYPE YoutubePostMetadata

Youtube post metadata

Fields 10

annotations : [Annotation!]!

Annotations representing entities in the text

category : YoutubeCategory

Post category

embeddable : Boolean!

Indicates whether the video allows embedding

isAiGenerated : Boolean!

Whether the post discloses AI-generated content

license : YoutubeLicense

Video license

madeForKids : Boolean!

Indicates whether the video is suitable for kids

notifySubscribers : Boolean!

Indicates whether to notify subscribers on publish video

privacy : YoutubePrivacy

Privacy setting for post

title : String

Title of the Youtube post

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Youtube

TYPE Asset

Asset interface with common fields

Fields 5

id : ID

The ID of the asset in the database

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 : AssetType!

The type of the asset

TYPE CommonPostMetadata

Common properties for all post metadata types

Fields 2

annotations : [Annotation!]!

Annotations representing entities in the text

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE ThreadedPostMetadata

Common properties for all posts that support threaded replies. See ThreadedPost for more details.

Fields 2

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

TYPE GoogleBusinessPostDetails

GoogleBusiness Metadata details

TYPE PostMetadata

Post metadata union type. Contains all possible types of post metadata.

Inputs 53

INPUT AggregatedPostMetricsInput

Input for the `aggregatedPostMetrics` query.

Fields 5

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.

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.

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`.

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

length : Int!

The length of the annotation, e.g. 6

link : String!

The link of the annotation, e.g. https://www.linkedin.com/company/bufferapp

localizedName : String!

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

start : Int!

The start of the annotation, e.g. 5

vanityName : String!

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

INPUT AssetInput

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

Fields 4

document : DocumentAssetInput

Document asset

image : ImageAssetInput

Image asset

link : LinkAssetInput

Use metadata.{service}.linkAttachment instead. This field will be removed on December 15, 2026.

video : VideoAssetInput

Video asset

INPUT BlueskyPostMetadataInput

Bluesky post metadata

Fields 2

linkAttachment : LinkAttachmentInput

Link attachment. Mutually exclusive with a non-empty `assets` array input providing both is rejected.

thread : [ThreadedPostInput!]

The ordered list of posts that make up the thread (not paginated). This array is the source of truth for what gets published: every post in the thread, including the root post, must be provided here. Posts are published in order, each replying to the previous one. The first item is the root post and should match the top-level `text` on the post input.

INPUT CreatePostInput

Create post's request input. Note: `metadata.{service}.linkAttachment` is mutually exclusive with a non-empty `assets` array. Input providing both is rejected.

Fields 14

aiAssisted : Boolean

If this post was created with the help of AI

assets : [AssetInput!]!

Ordered list of assets on this post.

channelId : ChannelId!

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

draftId : DraftId

Is set when the Post is generated from a Draft

dueAt : DateTime

Date when the post is scheduled to be published

ideaId : IdeaId

Is set when the Post is generated from an Idea

metadata : PostInputMetaData

Metadata of the post which differs based on the social network/service

mode : ShareMode!

How the post is being scheduled.

needsApproval : Boolean!

Submit the post for approval instead of scheduling it. A post submitted for approval is always a draft, so this conflicts with turning `saveToDraft` off. Only valid when your posting policy on the target channel requires approval.

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

schedulingType : SchedulingType!

Scheduling type to indicate notification publishing or automatic publishing

source : String

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

tagIds : [TagId!]

List of tag IDs

text : String

Text content of the Post. Note: for threaded posts, this needs to match the first item in the `thread` array.

INPUT CreatePostTemplateInput

Input for an end user creating a post template. Buffer-curated taxonomy fields are server-defaulted; setting them is only available to official Buffer clients.

Fields 6

body : String!

The main content body of the template, may contain {{placeholders}}.

description : String

A short user-facing description of the template. Nullable for backwards-compat at the GraphQL boundary the resolver rejects null/empty values with a clear input error so the underlying storage contract (non-empty string) is still honored.

emoji : String

The emoji associated with the template.

organizationId : OrganizationId!

Organization the template belongs to. The caller must be a member of this organization. For `internal` visibility this is the team scope; for `private` it's recorded on the template but does not affect visibility.

title : String!

The title of the template.

visibility : PostTemplateVisibility

Defaults to `private` if omitted. `public` is rejected it is only available to official Buffer clients.

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

end : DateTime

Include results with dates equal to or before the specified date

start : DateTime

Include results with dates equal to or after the specified date

INPUT DeletePostInput

deletePost mutation deletes a post by id.

Fields 1

id : PostId!

Post id to delete.

INPUT DeletePostTemplateInput Preview

Input for an end user deleting a post template.

Fields 1

id : PostTemplateId!

The ID of the template to delete.

INPUT DocumentAssetInput

Document asset

Fields 3

thumbnailUrl : String!

Document thumbnail URL

title : String!

Document title

url : String!

Document URL

INPUT EditPostInput

Edit post's request input. Note: `metadata.{service}.linkAttachment` is mutually exclusive with a non-empty `assets` array. Input providing both is rejected.

Fields 14

id : PostId!

ID of the post to edit

aiAssisted : Boolean

If this post was edited with the help of AI

approvalChange : PostApprovalChange

Change the post's approval state alongside this edit. Leave unset to keep the post's current approval state. Only valid when your posting policy on the post's channel requires approval, and only on your own drafts. Asking for the state the post is already in does nothing.

assets : [AssetInput!]

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

draftId : DraftId

Is set when the Post is generated from a Draft

dueAt : DateTime

Date when the post is scheduled to be published

ideaId : IdeaId

Is set when the Post is generated from an Idea

metadata : PostInputMetaData

Metadata of the post which differs based on the social network/service

mode : ShareMode

How the post is being scheduled. Omit the field or pass null to make no scheduling change null does not clear or reset the schedule: a scheduled post keeps its current share mode, queue slot, and any custom time, and the edit applies only the other provided fields. Pass a non-null ShareMode to apply that mode.

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

schedulingType : SchedulingType

Scheduling type to indicate notification publishing or automatic publishing. Omit it, or send null, to leave the post publishing the way it already does.

source : String

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

tagIds : [TagId!]

Enums 26

ENUM AnnotationType

List of possible types for an annotation

ENUM AssetType

Asset types

ENUM DateTimePresence

Presence filter for nullable date fields. When filtering the same field, absent dates cannot also match a date comparator range.

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 PostApprovalChange

A change to a post's approval state, for a post that is already a draft.

ENUM PostingGoalStatus

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

ENUM 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.

ENUM PostMetricUnit

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 PostTemplateVisibility Preview

The visibility level of a post template. `public` is reserved for Buffer-curated templates; setting it is only available to official Buffer clients.

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 QueuePosition Experimental

Target position within a channel's queue that a post can be moved to.

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 TagColorName

Stable Buffer identifiers for the supported tag color palette. Clients map these values to platform- and theme-specific presentation. Values ending in `Light` are lighter palette variants, not UI theme modes.

ENUM YoutubeLicense

List of license types

ENUM YoutubePrivacy

List of privacy types

Scalars 6

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 PostTemplateId

The `PostTemplateId` scalar represents the MongoDB ObjectId of a Post Template.

SCALAR TagId

The `TagId` scalar represents the MongoDB ObjectId of a Buffer Tag

Ideas

Queries 2

QUERY ideaGroups (input: IdeaGroupsInput!) : [IdeaGroup!]!

Retrieves idea groups based on the provided input parameters.

Arguments

Name	Type	Description
input Required	IdeaGroupsInput!	Input for retrieving idea groups.

Example Response

{
  "data": {
    "ideaGroups": [
      {
        "id": "...",
        "isLocked": true,
        "name": "..."
      }
    ]
  }
}

QUERY ideas (after: String, first: Int, input: IdeasInput!) : IdeasConnection!

Fetch a paginated list of ideas with optional filtering

Arguments

Name	Type	Description
after Optional	String	Cursor for pagination, marks where to start fetching from
first Optional	Int	Maximum number of items to return
input Required	IdeasInput!	Filtering criteria for the ideas list

Example Response

{
  "data": {
    "ideas": {
      "edges": [
        {
          "cursor": "...",
          "node": {}
        }
      ],
      "pageInfo": {
        "endCursor": "...",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "..."
      }
    }
  }
}

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 3

OUTPUT IdeaGroup

Idea groups are used to organize ideas in the board

Fields 3

id : ID!

Unique identifier for the idea group.

isLocked : Boolean!

Whether the idea group is locked.

name : String!

The name of the idea group.

OUTPUT IdeasConnection

Relay connection for paginated ideas.

Fields 2

edges : [IdeaEdge!]!

List of idea edges containing the ideas and their cursors

pageInfo : PaginationPageInfo!

Pagination metadata including hasNextPage and endCursor

OUTPUT CreateIdeaPayload

createIdea response (including errors)

Types 9

TYPE Idea

Ideas are the main entity in the create space

Fields 7

id : ID!

Unique identifier for the idea

content : IdeaContent!

The actual content and metadata of the idea

groupId : ID

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

organizationId : ID!

ID of the organization that owns this idea

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

aiAssisted : Boolean!

Indicates whether AI tools were used in creating this idea

date : DateTime

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

media : [IdeaMedia!]

List of media items attached to the idea

services : [Service!]!

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

tags : [PublishingTag!]!

Tags used to categorize and organize the idea

text : String

Main body text or description of the idea

title : String

Title or headline of the idea

TYPE IdeaEdge

Pagination type for Ideas

Fields 2

cursor : String!

Opaque cursor for pagination, used to fetch subsequent pages

node : Idea!

The idea object

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 PaginationPageInfo

Information to aid in pagination.

Fields 4

endCursor : String

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

hasNextPage : Boolean!

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

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.

startCursor : String

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

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 6

INPUT CreateIdeaInput

createIdea input type

Fields 5

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)

organizationId : ID!

Organization ID that will own the idea

templateId : String

Template ID used to create the idea

INPUT IdeaContentInput

content input for creating/updating an idea

Fields 7

aiAssisted : Boolean

Whether AI tools were used in creation

date : DateTime

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

media : [IdeaMediaInput!]

List of media items to attach

services : [Service!]

Services associated with the idea for targeting specific platforms

tags : [TagInput!]

Tags to categorize the idea

text : String

Main body text or description

title : String

Title or headline of the idea

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 IdeaGroupsInput

Input type for retrieving idea groups by organization ID.

Fields 1

organizationId : ID!

Unique identifier for the organization.

INPUT IdeasGroupFilter

Selects which ideas to return by group membership. Exactly one field must be provided (enforced by @oneOf). To return ideas from all groups, omit `groupFilter` on IdeasInput rather than setting a field here.

Fields 2

groups : [ID!]

Return only ideas that belong to these specific groups (union/OR).

membership : IdeaGroupMembership

Return ideas by a group-membership bucket rather than by specific group IDs.

INPUT IdeasInput

Filtering criteria for the ideas list.

Fields 3

groupFilter : IdeasGroupFilter

Filter ideas by group membership. Omit this field entirely to return ideas across all groups.

organizationId : OrganizationId!

The organization to fetch ideas from.

tagsFilter : TagComparator

Filter ideas by tags using TagComparator.

Enums 1

ENUM IdeaGroupMembership

Named buckets for filtering ideas by their group membership.

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 11

channels : Int!

The maximum number of channels allowed for the organization.

generateContent : Int!

The maximum number of content generations allowed for the organization.

ideaGroups : Int!

The maximum number of idea groups allowed for the organization.

ideas : Int!

The maximum number of ideas allowed for the organization.

members : Int!

The maximum number of members allowed for the organization.

postTemplates : Int!

The maximum number of post templates allowed for the organization.

savedReplies : Int!

The maximum number of saved replies allowed for the organization.

scheduledPosts : Int!

The maximum number of scheduled posts allowed for the organization.

scheduledStoriesPerChannel : Int!

The maximum number of scheduled stories allowed per channel.

scheduledThreadsPerChannel : Int!

The maximum number of scheduled threads allowed per channel.

tags : Int!

The maximum number of tags allowed for the organization.

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 9

TYPE DocumentAsset

Document asset

Fields 6

id : ID

The ID of the asset in the database

document : DocumentMetadata!

Document specific metadata

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 : AssetType!

The type of the asset

TYPE DocumentMetadata

Document metadata

Fields 4

filesize : Int

Document fileSize in bytes

numPages : Int!

Number of pages in the document

thumbnails : [String!]!

URLs to the static thumbnails of the document pages

title : String

Document title

TYPE ImageAsset

Image asset

Fields 6

id : ID

The ID of the asset in the database

image : ImageMetadata!

Image specific metadata

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 : AssetType!

The type of the asset

TYPE ImageMetadata

Image metadata

Fields 6

altText : String!

Alternative text for accessibility

animatedThumbnail : String

Animated thumbnail URL

height : Int!

Image height in pixels

isAnimated : Boolean!

Is the image animated?

userTags : [UserTag!]

User tags in the image

width : Int!

Image width in pixels

TYPE VideoAsset

Video asset

Fields 6

id : ID

The ID of the asset in the database

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 : AssetType!

The type of the asset

video : VideoMetadata!

Video specific metadata

TYPE VideoMetadata

Video metadata

Fields 14

audioCodec : String

Audio codec

containerFormat : String

Video container format

durationMs : Int!

Video duration in seconds

fileSize : Int

Video fileSize in bytes

frameRate : Int

Video framerate

height : Int!

Video height in pixels

isTranscodingRequired : Boolean!

Whether the video needs to be transcoded before it can be broadcasted

isVideoProcessing : Boolean!

Whether the video is currently being processed (transcoding in progress)

rotationDegree : Int

Rotation degree

thumbnailOffset : Int

Offset of the thumbnail chosen for the video, in ms

title : String

Video title

videoBitRate : Int

Video bitrate in kbps

videoCodec : String

Video codec

width : Int!

Video width in pixels

TYPE MutationError

Base Mutation Error type

Fields 1

message : String!

Error message

TYPE MutationSuccess

Base Mutation Success type Used when we have a success response with no data, we return this type with empty string

Fields 1

_empty : String!

The value is alwaus an empty string '' Note: GraphQL doesn't allow types with no fields, so we have to add this field

TYPE ScrapedLink

Link data for link preview

Fields 3

text : String!

Description for the scraped link

thumbnails : [String!]!

Thumbnails of media available in the link

url : String!

URL that the link asset has been built from

Scalars 3

SCALAR Email

The `Email` scalar represents a valid, normalized email address. Input is trimmed and lowercased before validation.

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

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

content : String!

indices : [Int!]!

The indices of the annotation in the text

text : String!

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

type : AnnotationType!

The type of the annotation

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.

avatar : String!

The avatar URL of the author.

email : String!

The email address 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

BlueskyMetadata

Bluesky metadata

Fields 1

serverUrl : String!

The instance of bluesky of the channel

TYPE

BlueskyPostMetadata

Bluesky post metadata

Implements: CommonPostMetadata ThreadedPostMetadata

Fields 5

annotations : [Annotation!]!

Annotations representing entities in the text

linkAttachment : LinkAttachment

Link attachment

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE

Channel

Channel entity

Fields 27

id : ChannelId!

The ID of the channel

allowedActions : [ChannelAction!]!

The allowed actions for the current user

avatar : String!

The avatar URL 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?)

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

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

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

isQueuePaused : Boolean!

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

linkShortening : ChannelLinkShortening!

Link Shortening settings for the channel

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

postingGoal : PostingGoal

The posting goal for the channel

postingSchedule : [ScheduleV2!]!

Provides the posting slots for each day of the week

products : [Product!]

Products that support a given channel

scopes : [String]!

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

service : Service!

Represents the social network

serviceId : String!

Represents the external ID of the channel on social network API

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.

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.

weeklyPostingLimit : WeeklyPostingLimit

Deprecated

Weekly posting limit for the channel

Deprecation reason: This field is not used anymore

createdAt : DateTime!

The creation date of the channel

updatedAt : DateTime!

The last time the channel was updated

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 8

category : ConnectedAppCategory

The category of the connected app, when known.

clientId : ID!

The id of the connectedApp.

description : String!

A brief description of the connected app.

name : String!

The name of the connected app.

scopes : [String!]!

The access scopes granted to this connection for Buffer's public API resources. Empty when the connection holds none.

userId : ID!

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

website : String!

The website URL of the connected app.

createdAt : DateTime!

The date and time when the connected app was created.

TYPE Preview

CreatePostTemplateSuccess

Successful result of an end user creating a post template.

Fields 1

postTemplate : PostTemplate!

The newly created post template.

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.

isAtLimit : Boolean!

Whether the channel has reached its daily posting limit.

limit : Int

The network daily posting limit. Null means unlimited.

scheduled : Int!

Number of posts scheduled for this day.

sent : Int!

Number of posts already sent on this day.

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

document : DocumentMetadata!

Document specific metadata

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 : AssetType!

The type of the asset

TYPE

DocumentMetadata

Document metadata

Fields 4

filesize : Int

Document fileSize in bytes

numPages : Int!

Number of pages in the document

thumbnails : [String!]!

URLs to the static thumbnails of the document pages

title : String

Document title

TYPE

EmptySuccess

Empty mutation success response used when client doesn't need any data back or simply needs to respond to a success or error.

Implements: MutationSuccess

Fields 1

_empty : String!

The value is always an empty string '' Note: GraphQL doesn't allow types with no fields, so we have to add this field

TYPE

FacebookMetadata

Facebook metadata

Fields 1

locationData : LocationData

Metadata about the location of the business associated with the channel. Only available for Facebook and GPB

TYPE

FacebookPostMetadata

Facebook post metadata

Implements: CommonPostMetadata

Fields 5

annotations : [Annotation!]!

Annotations representing entities in the text

firstComment : String

Facebook post's first comment

linkAttachment : LinkAttachment

Link attachment

title : String

Title of Facebook reel

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE

GoogleBusinessEventMetaData

Metadata for a GBP post that is an event

Fields 8

button : GoogleBusinessPostActionType!

Action button

endDate : DateTime!

End date of the event

endTime : String

Deprecated

End time of the event

Deprecation reason: get time from the endDate

isFullDayEvent : Boolean!

Indicate whether the event has a start or end time.

link : String

Link to the action

startDate : DateTime!

Start date of the event

startTime : String

Deprecated

Start time of the event

Deprecation reason: get time from the startDate

title : String!

Title of the event

TYPE

GoogleBusinessMetadata

Google Business metadata

Fields 1

locationData : LocationData

Metadata about the location of the business associated with the channel. Only available for Facebook and GPB

TYPE

GoogleBusinessOfferMetaData

Metadata for a GBP post that is an offer

Fields 6

code : String

Coupon code for the offer

endDate : DateTime!

End date of the offer

link : String

Link to the offer

startDate : DateTime!

Start date of the offer

terms : String

Terms and Conditions

title : String!

Title of the offer

TYPE

GoogleBusinessPostMetadata

Google Business Profile post metadata @deprecated: pending proposal for specific GBP post types: update, offer and event metadata types

Implements: CommonPostMetadata

Fields 4

annotations : [Annotation!]!

Annotations representing entities in the text

details : GoogleBusinessPostDetails

Details of the metadata

title : String

Title if available in the given GBP post type: event and offer

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE

GoogleBusinessWhatsNewMetaData

Metadata for a GBP post of type Whats new

Fields 2

button : GoogleBusinessPostActionType!

Action button

link : String

Link to the action

TYPE

Idea

Ideas are the main entity in the create space

Fields 7

id : ID!

Unique identifier for the idea

content : IdeaContent!

The actual content and metadata of the idea

groupId : ID

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

organizationId : ID!

ID of the organization that owns this idea

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

aiAssisted : Boolean!

Indicates whether AI tools were used in creating this idea

date : DateTime

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

media : [IdeaMedia!]

List of media items attached to the idea

services : [Service!]!

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

tags : [PublishingTag!]!

Tags used to categorize and organize the idea

Media attached to an idea

Fields 7

id : ID!

Unique identifier for the media in Buffer's upload system

alt : String

Alternative text description for accessibility

size : Int

File size in bytes

source : IdeaMediaSource

Source platform information for the media

thumbnailUrl : String

URL to a smaller version of the media for preview purposes

type : MediaType!

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

url : String!

Direct URL to access the media file

TYPE

IdeaMediaSource

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

Fields 4

id : String

Unique identifier from the source platform

author : String

Name of the content creator/author

Fields 6

id : ID

The ID of the asset in the database

image : ImageMetadata!

Image specific metadata

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 : AssetType!

The type of the asset

TYPE

ImageMetadata

Image metadata

Fields 6

altText : String!

Alternative text for accessibility

animatedThumbnail : String

Animated thumbnail URL

height : Int!

Image height in pixels

isAnimated : Boolean!

Is the image animated?

userTags : [UserTag!]

User tags in the image

width : Int!

Image width in pixels

TYPE

InstagramGeolocation

Instagram Geolocation

Fields 2

id : String

The id of this location

text : String

The name of this location

TYPE

InstagramMetadata

Instagram metadata

Fields 1

defaultToReminders : Boolean!

Indicates if we should default to reminder for Instagram

TYPE

InstagramPostMetadata

Instagram post metadata

Implements: CommonPostMetadata

Fields 8

annotations : [Annotation!]!

Annotations representing entities in the text

firstComment : String

Instagram post's first comment

geolocation : InstagramGeolocation

Geolocation of the post

isAiGenerated : Boolean!

Whether the post discloses AI-generated content

link : String

Shop Grid link for the post

shouldShareToFeed : Boolean!

Indicates whether post should be shared to feed

stickerFields : InstagramStickerFields

Sticker fields for reminder-based publishing

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

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

music : String

Placeholder text for the post's music

other : String

Additional field for any other post content

products : String

Placeholder text for the post's linked products

text : String

Text for the Story or Reel

expandedUrl : String

Full URL that the link asset has been built from

text : String!

Description for the scraped link

thumbnail : String

Selected thumbnail for this link preview

thumbnails : [String!]!

Thumbnails of media available in the link

title : String!

Title for the link attachment

url : String!

URL that the link asset has been built from

TYPE

LinkedInMetadata

LinkedIn metadata

Fields 1

shouldShowLinkedinAnalyticsRefreshBanner : Boolean!

Property parsed from scopes indicating whether the client should show the LinkedIn analytics refresh banner

TYPE

LinkedInPostMetadata

LinkedIn post metadata

Implements: CommonPostMetadata

Fields 4

annotations : [Annotation!]!

Annotations representing entities in the text

firstComment : String

LinkedIn post's first comment

Mastodon metadata

Fields 2

maxCharacters : Int!

Maximum character limit allowed for this channel's server instance

serverUrl : String!

The instance of mastodon of the channel

TYPE

MastodonPostMetadata

Mastodon post metadata

Implements: CommonPostMetadata ThreadedPostMetadata

Fields 5

annotations : [Annotation!]!

Annotations representing entities in the text

spoilerText : String

Spoiler text hiding the root text of this post

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

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.

allowedActions : [NoteAction!]!

The allowed actions a user can perform on the note.

author : Author!

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

text : String!

The content of the note.

type : NoteType!

The type of the note.

createdAt : DateTime!

The date and time when the note was created.

updatedAt : DateTime

The date and time when the note was last edited.

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 11

channels : Int!

The maximum number of channels allowed for the organization.

generateContent : Int!

The maximum number of content generations allowed for the organization.

ideaGroups : Int!

The maximum number of idea groups allowed for the organization.

ideas : Int!

The maximum number of ideas allowed for the organization.

members : Int!

The maximum number of members allowed for the organization.

postTemplates : Int!

The maximum number of post templates allowed for the organization.

savedReplies : Int!

The maximum number of saved replies allowed for the organization.

scheduledPosts : Int!

The maximum number of scheduled posts allowed for the organization.

scheduledStoriesPerChannel : Int!

The maximum number of scheduled stories allowed per channel.

scheduledThreadsPerChannel : Int!

The maximum number of scheduled threads allowed per channel.

tags : Int!

The maximum number of tags allowed for the organization.

TYPE

PaginationPageInfo

Information to aid in pagination.

Fields 4

endCursor : String

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

hasNextPage : Boolean!

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

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.

startCursor : String

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

TYPE

PinterestBoard

A Pinterest board

Fields 6

id : String!

The ID of the board

avatar : String

The board avatar

description : String

The board description

name : String!

The board name

serviceId : String!

The ID of the service

url : String!

The board URL

TYPE

PinterestMetadata

Pinterest metadata

Fields 1

boards : [PinterestBoard!]!

The list of boards the user has on Pinterest

TYPE

PinterestPostMetadata

Pinterest post metadata

Implements: CommonPostMetadata

Fields 5

annotations : [Annotation!]!

Annotations representing entities in the text

board : PinterestBoard

The board the Pin is saved to

title : String

The title of the Pin

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

url : String

The Pin destination link

TYPE

Post

Post entity

Fields 27

id : PostId!

ObjectId of the post

allowedActions : [PostAction!]!

Indicates what actions the current account can perform on the post

assets : [Asset!]!

assets

author : Author

Represents the user who created the post

channel : Channel!

channel

channelId : ChannelId!

channel ID (faster than resolving the channnel.id)

channelService : Service!

channel service (faster than resolving the channnel.service)

dueAt : DateTime

Date when the post is scheduled to be published

error : PostPublishingError

error

externalLink : String

The external URL of the post at the destination service

ideaId : IdeaId

Is set when the Post is generated from an Idea

isCustomScheduled : Boolean!

Indicates whether time to publish was manually selected by the user

metadata : PostMetadata

Metadata of the post which differs based on the social network/service @see post.metadata.graphql

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.

notes : [Note!]!

notes

notificationStatus : NotificationStatus

notificationStatus: notified or markedAsPublished

schedulingType : SchedulingType

How the post publishes: notification for a reminder that asks someone to publish it by hand, automatic for one the publishing workers send.

sentAt : DateTime

Date when the post is published

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)

status : PostStatus!

status

tags : [Tag!]!

tags - sorted by name in ascending order

text : String!

Text content of the Post

via : PostVia!

Indicates if the post is created from Buffer or the API

createdAt : DateTime!

Date when the post was created

updatedAt : DateTime!

Date when the post was updated

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.

periodEnd : DateTime!

The end date of the period for this posting goal.

id : PostTemplateId! Preview

The unique identifier for the template.

body : String! Preview

The main content body of the template, may contain {{placeholders}}.

description : String! Preview

A short user-facing description of the template.

emoji : String! Preview

The emoji associated with the template.

organizationId : OrganizationId! Preview

The organization that owns this template.

title : String! Preview

The title of the template.

visibility : PostTemplateVisibility! Preview

The visibility level of the template. public is returned for Buffer-managed templates.

createdAt : DateTime! Preview

The date and time the template was created.

updatedAt : DateTime! Preview

The date and time the template was last updated.

Tag snapshot associated with content

Fields 4

id : ID!

No description provided.

color : String!

Hex color for tag e.g #F523F1

colorName : TagColorName

Stable Buffer palette identifier derived from color. Clients should map this value to platform- and theme-specific presentation, falling back to color when this field is null or unsupported. Returns null for custom or unrecognized colors.

name : String!

No description provided.

TYPE

RestProxyError

Error proxied from the REST API response

Implements: MutationError

Fields 3

code : Int

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

link : String

Link to our Help center from the REST API response

message : String!

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

TYPE

RetweetMetadata

Information about the initial Tweet that was retweeted

Implements: ScrapedLink

Fields 6

id : String!

Retweet ID

text : String!

Text of the original tweet

thumbnails : [String!]!

Thumbnails to media available in the link

url : String!

Link to original tweet

user : RetweetUserMetadata!

User who created the original tweet

createdAt : DateTime!

Date when the original tweet was created

TYPE

RetweetUserMetadata

Information about the initial author of the Tweet that was retweeted

Fields 3

avatar : String!

Avatar of the user who created the original Tweet

name : String!

Name of the user who created the original Tweet

username : String!

Username of the user who created the original Tweet

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

paused : Boolean!

Indicates if this day is paused in the posting schedule.

times : [String!]!

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

TYPE

ThreadedPost

Fields 4

assets : [Asset!]!

Media assets of the threaded post

linkAttachment : LinkAttachment

Deprecated

Use metadata.{service}.linkAttachment on the thread item instead. This field will be removed on December 15, 2026.

Deprecation reason: Use metadata.{service}.linkAttachment on the thread item instead. This field will be removed on December 15, 2026.

metadata : ThreadItemMetadata

Service-specific fields for this threaded post

Threads fields on a single item of a thread

Fields 1

linkAttachment : LinkAttachment

Link attachment

TYPE

ThreadsPostMetadata

Threads post metadata

Implements: CommonPostMetadata ThreadedPostMetadata

Fields 8

annotations : [Annotation!]!

Annotations representing entities in the text

linkAttachment : LinkAttachment

Link attachment

locationId : String

LocationId associated with the post

locationName : String

Location name associated with the post

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

topic : String

Topic associated with the post

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE

TiktokMetadata

Tiktok metadata

Fields 1

defaultToReminders : Boolean!

Indicates if we should default to reminder for Tiktok

TYPE

TiktokPostMetadata

Tiktok post metadata

Implements: CommonPostMetadata

Fields 4

annotations : [Annotation!]!

Annotations representing entities in the text

isAiGenerated : Boolean!

Whether the post discloses AI-generated content (TikTok video only)

title : String

The title of the TikTok post (for photo posts)

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

TYPE

TwitterMetadata

Twitter metadata

Fields 1

subscriptionType : String

Indicates the type of subscription the user has on Twitter

TYPE

TwitterPostMetadata

Twitter post metadata

Implements: CommonPostMetadata ThreadedPostMetadata

Fields 6

annotations : [Annotation!]!

Annotations representing entities in the text

isAiGenerated : Boolean!

Whether the post discloses AI-generated content

retweet : RetweetMetadata

The details of the tweet being retweeted

thread : [ThreadedPost!]!

The list of threaded posts (not paginated)

threadCount : Int!

The number of threaded posts

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

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 Preview

UpdatePostTemplateSuccess

Successful result of an end user updating a post template.

Fields 1

postTemplate : PostTemplate!

The updated post template.

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

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 : AssetType!

The type of the asset

video : VideoMetadata!

Video specific metadata

TYPE

VideoMetadata

Video metadata

Fields 14

audioCodec : String

Audio codec

containerFormat : String

Video container format

durationMs : Int!

Video duration in seconds

fileSize : Int

Video fileSize in bytes

frameRate : Int

Video framerate

height : Int!

Video height in pixels

isTranscodingRequired : Boolean!

Whether the video needs to be transcoded before it can be broadcasted

isVideoProcessing : Boolean!

Whether the video is currently being processed (transcoding in progress)

rotationDegree : Int

Rotation degree

thumbnailOffset : Int

Offset of the thumbnail chosen for the video, in ms

title : String

Video title

videoBitRate : Int

Video bitrate in kbps

videoCodec : String

Video codec

width : Int!

Video width in pixels

TYPE

VoidMutationError

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

limit : Int!

The weekly posting limit for the channel

scheduled : Int!

The number of posts the channel has scheduled for this week

sent : Int!

The number of posts the channel has sent this week

TYPE

YoutubeCategory

Fields 2

categoryId : String!

No description provided.

title : String!

No description provided.

TYPE

YoutubeMetadata

Youtube metadata

Fields 1

defaultToReminders : Boolean!

Indicates if we should default to reminder for Youtube

TYPE

YoutubePostMetadata

Youtube post metadata

Implements: CommonPostMetadata

Fields 10

annotations : [Annotation!]!

Annotations representing entities in the text

category : YoutubeCategory

Post category

embeddable : Boolean!

Indicates whether the video allows embedding

isAiGenerated : Boolean!

Whether the post discloses AI-generated content

license : YoutubeLicense

Video license

madeForKids : Boolean!

Indicates whether the video is suitable for kids

notifySubscribers : Boolean!

Indicates whether to notify subscribers on publish video

privacy : YoutubePrivacy

Privacy setting for post

title : String

Title of the Youtube post

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Youtube

INPUT

AggregatedPostMetricsInput

Input for the aggregatedPostMetrics query.

Fields 5

channelIds : [ChannelId!]

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.

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.

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

length : Int!

The length of the annotation, e.g. 6

link : String!

The link of the annotation, e.g. https://www.linkedin.com/company/bufferapp

localizedName : String!

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

start : Int!

The start of the annotation, e.g. 5

vanityName : String!

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

INPUT

AssetInput

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

Fields 4

document : DocumentAssetInput

Document asset

image : ImageAssetInput

Image asset

link : LinkAssetInput

Use metadata.{service}.linkAttachment instead. This field will be removed on December 15, 2026.

video : VideoAssetInput

Video asset

INPUT

BlueskyPostMetadataInput

Bluesky post metadata

Fields 2

linkAttachment : LinkAttachmentInput

Input to pass when fetching channels.

Fields 2

filter : ChannelsFiltersInput

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

organizationId : OrganizationId!

The Organization id to fetch channels for

INPUT

CreateIdeaInput

createIdea input type

Fields 5

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)

organizationId : ID!

Organization ID that will own the idea

templateId : String

Template ID used to create the idea

INPUT

CreatePostInput

Create post's request input.

Note: metadata.{service}.linkAttachment is mutually exclusive with a non-empty assets array. Input providing both is rejected.

Fields 14

aiAssisted : Boolean

If this post was created with the help of AI

assets : [AssetInput!]!

Ordered list of assets on this post.

channelId : ChannelId!

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

draftId : DraftId

Is set when the Post is generated from a Draft

dueAt : DateTime

Date when the post is scheduled to be published

ideaId : IdeaId

Is set when the Post is generated from an Idea

metadata : PostInputMetaData

Metadata of the post which differs based on the social network/service

mode : ShareMode!

How the post is being scheduled.

needsApproval : Boolean!

Submit the post for approval instead of scheduling it. A post submitted for approval is always a draft, so this conflicts with turning saveToDraft off.

Only valid when your posting policy on the target channel requires approval.

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

schedulingType : SchedulingType!

Scheduling type to indicate notification publishing or automatic publishing

source : String

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

tagIds : [TagId!]

List of tag IDs

text : String

Text content of the Post.

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

INPUT

CreatePostTemplateInput

Input for an end user creating a post template. Buffer-curated taxonomy fields are server-defaulted; setting them is only available to official Buffer clients.

Fields 6

body : String! Preview

The main content body of the template, may contain {{placeholders}}.

description : String Preview

emoji : String Preview

The emoji associated with the template.

organizationId : OrganizationId! Preview

Organization the template belongs to. The caller must be a member of this organization. For internal visibility this is the team scope; for private it's recorded on the template but does not affect visibility.

id : PostId!

Post id to delete.

INPUT Preview

DeletePostTemplateInput

Input for an end user deleting a post template.

Fields 1

id : PostTemplateId!

The ID of the template to delete.

INPUT

DocumentAssetInput

Document asset

Fields 3

thumbnailUrl : String!

Document thumbnail URL

title : String!

Document title

url : String!

Document URL

INPUT

EditPostInput

Edit post's request input.

Note: metadata.{service}.linkAttachment is mutually exclusive with a non-empty assets array. Input providing both is rejected.

Fields 14

id : PostId!

ID of the post to edit

aiAssisted : Boolean

If this post was edited with the help of AI

approvalChange : PostApprovalChange

Change the post's approval state alongside this edit. Leave unset to keep the post's current approval state.

Only valid when your posting policy on the post's channel requires approval, and only on your own drafts. Asking for the state the post is already in does nothing.

assets : [AssetInput!]

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

draftId : DraftId

Is set when the Post is generated from a Draft

dueAt : DateTime

Date when the post is scheduled to be published

ideaId : IdeaId

Is set when the Post is generated from an Idea

metadata : PostInputMetaData

Metadata of the post which differs based on the social network/service

mode : ShareMode

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

schedulingType : SchedulingType

Scheduling type to indicate notification publishing or automatic publishing.

Omit it, or send null, to leave the post publishing the way it already does.

source : String

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

tagIds : [TagId!]

FacebookPostMetadataInput

Facebook post metadata

Fields 4

annotations : [AnnotationInputFacebook!]

Annotations representing entities in the text

firstComment : String

Facebook post's first comment

linkAttachment : LinkAttachmentInput

Link attachment. Mutually exclusive with a non-empty assets array input providing both is rejected.

type : PostTypeFacebook!

The channel-specific type of the post, eg, post, story, reel for Facebook

INPUT

GoogleBusinessEventMetaDataInput

Metadata for a GBP post that is an event

Fields 6

button : GoogleBusinessPostActionType

Action button. Optional: a post with no button, or none, publishes without a call-to-action. On edit, omitting it preserves the existing value.

endDate : DateTime

End date of the event. Required on create; optional on edit (omitted preserves existing value).

isFullDayEvent : Boolean!

Indicate whether the event has a start or end time.

link : String

Link to the action

startDate : DateTime

Start date of the event. Required on create; optional on edit (omitted preserves existing value).

title : String

Title of the event. Required on create; optional on edit (omitted preserves existing value).

INPUT

GoogleBusinessOfferMetaDataInput

Metadata for a GBP post that is an offer

Fields 6

code : String

Coupon code for the offer

endDate : DateTime

End date of the offer. Required on create; optional on edit (omitted preserves existing value).

link : String

Link to the offer

startDate : DateTime

Start date of the offer. Required on create; optional on edit (omitted preserves existing value).

terms : String

Terms and Conditions

title : String

Title of the offer. Required on create; optional on edit (omitted preserves existing value).

INPUT

GoogleBusinessPostMetadataInput

Google Business Profile post metadata @deprecated: pending proposal for specific GBP post types: update, offer and event metadata types

Fields 5

detailsEvent : GoogleBusinessEventMetaDataInput

Details of the Event metadata

detailsOffer : GoogleBusinessOfferMetaDataInput

Details of the Offer metadata

detailsWhatsNew : GoogleBusinessWhatsNewMetaDataInput

Details of the Whats new metadata

title : String

Title if available in the given GBP post type: event and offer

type : PostTypeGoogleBusiness!

The channel-specific type of the post, eg, post, offer, event for Google Business Profile

INPUT

GoogleBusinessWhatsNewMetaDataInput

Metadata for a GBP post of type Whats new

Fields 2

button : GoogleBusinessPostActionType

Action button. Optional: a post with no button, or none, publishes without a call-to-action. On edit, omitting it preserves the existing value.

link : String

Link to the action

INPUT

IdeaContentInput

content input for creating/updating an idea

Fields 7

aiAssisted : Boolean

Whether AI tools were used in creation

date : DateTime

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

media : [IdeaMediaInput!]

List of media items to attach

services : [Service!]

Services associated with the idea for targeting specific platforms

tags : [TagInput!]

Tags to categorize the idea

text : String

Main body text or description

title : String

Title or headline of the idea

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

IdeaGroupsInput

Input type for retrieving idea groups by organization ID.

Fields 1

organizationId : ID!

Unique identifier for the organization.

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.

firstComment : String

Instagram post's first comment

geolocation : InstagramGeolocationInput

Geolocation of the post

isAiGenerated : Boolean

Whether the post discloses AI-generated content

link : String

Shop Grid link for the post

shouldShareToFeed : Boolean!

Indicates whether post should be shared to feed

stickerFields : InstagramStickerFieldsInput

Sticker fields for reminder-based publishing

type : PostType!

The channel-specific type of the post, eg, post, story, reel for Instagram

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

music : String

Placeholder text for the post's music

url : String!

URL of the thumbnail image

INPUT

LinkedInPostMetadataInput

LinkedIn post metadata

Fields 3

annotations : [AnnotationInputLinkedIn!]

Annotations representing entities in the text

firstComment : String

LinkedIn post's first comment

linkAttachment : LinkAttachmentInput

Link attachment. Mutually exclusive with a non-empty assets array input providing both is rejected.

INPUT

MastodonPostMetadataInput

Mastodon post metadata

Fields 2

spoilerText : String

Spoiler text hiding the root text of this post

thread : [ThreadedPostInput!]

INPUT Experimental

MovePostInQueueInput

movePostInQueue mutation moves a queued post to the top or bottom of its channel's queue.

Fields 2

id : PostId!

ID of the post to move.

position : QueuePosition!

Target position within the channel's queue.

INPUT

OrganizationFilterInput

Allow retrieving a specific Organization

Fields 1

organizationId : String!

No description provided.

INPUT

PinterestPostMetadataInput

Pinterest post metadata

Fields 3

boardServiceId : String

The board ID of the Pin, can be obtained when fetching the channel details with the following query:

Copy Copied!

query GetChannelWithSubprofiles {
  channel(input: { id: "[CHANNEL_ID_HERE]" }) {
    metadata {
      ... on PinterestMetadata {
        boards {
          serviceId
        }
      }
    }
  }
}

Required on create; optional on edit (omitted preserves existing board).

title : String

The title of the Pin

url : String

The Pin destination link

INPUT

PostInput

Input for the post query

Fields 1

id : PostId!

The ID of the post to be retrieved

INPUT

PostInputMetaData

Metadata of the post which differs based on the social network/service

Fields 11

bluesky : BlueskyPostMetadataInput

Metadata for Bluesky post

facebook : FacebookPostMetadataInput

Metadata for Facebook post

google : GoogleBusinessPostMetadataInput

Metadata for Google Business Profile post

instagram : InstagramPostMetadataInput

Metadata for Instagram post

linkedin : LinkedInPostMetadataInput

Metadata for LinkedIn post

mastodon : MastodonPostMetadataInput

Metadata for Mastodon post

pinterest : PinterestPostMetadataInput

Metadata for Pinterest post

threads : ThreadsPostMetadataInput

Metadata for Threads post

tiktok : TikTokPostMetadataInput

Metadata for TikTok post

twitter : TwitterPostMetadataInput

Metadata for Twitter post

youtube : YoutubePostMetadataInput

Metadata for Youtube post

INPUT

PostsFiltersInput

Filter to apply to the posts query

Fields 10

channelIds : [ChannelId!]

When set, it will filter posts by channel

dueAt : DateTimeComparator

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

dueAtPresence : DateTimePresence

When set, it will filter posts by whether their scheduled posting date exists. absent cannot be combined with dueAt, because absent dates cannot also match a date range.

endDate : DateTime

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

postTypes : [PostType!] Experimental

When set, it will filter posts by format.

post is a fallback bucket rather than one stored format: it matches every post the other formats do not claim, which is what Post.metadata.type reports for the same post. carousel and thread are rejected, because no stored value resolves to them.

startDate : DateTime

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

status : [PostStatus!]

When set, it will filter posts by status

tagIds : [TagId!]

When set, it will filter posts by tag

tags : TagComparator

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

createdAt : DateTimeComparator

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

INPUT

PostsInput

Input for the posts query

Fields 3

filter : PostsFiltersInput

The filters to apply to the posts query

organizationId : OrganizationId!

The Organization id to fetch posts for

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

direction : SortDirection!

The direction to sort by.

field : PostSortableKey!

The field to sort by.

INPUT Preview

PostTemplateInput

Input for fetching a single post template by ID.

Fields 1

id : PostTemplateId!

The unique identifier of the template to fetch.

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

ThreadedPostInput

A post authored by the user which is posted to a thread. This is commonly used for long-format twitter and meta threads posts to allow authored content to span multiple threads. Threads are represented as a list of replies, each replying to the previous one. The first item in the list is the root post of the thread and should match the top-level text on the post input; the remaining items are replies.

Fields 3

assets : [AssetInput!]!

Ordered list of assets on this threaded post

metadata : ThreadItemMetadataInput

Service-specific fields for this threaded post

Threads fields on a single item of a thread

Fields 1

linkAttachment : LinkAttachmentInput

Link attachment. Mutually exclusive with a non-empty assets array input providing both is rejected.

INPUT

ThreadsPostMetadataInput

Threads post metadata

Fields 6

linkAttachment : LinkAttachmentInput

Link attachment. Mutually exclusive with a non-empty assets array input providing both is rejected.

locationId : String

LocationId associated with the post

locationName : String

Location name associated with the post

thread : [ThreadedPostInput!]

topic : String

Topic associated with the post

type : PostType

The type of the post

INPUT

TikTokPostMetadataInput

TikTok post metadata

Fields 2

isAiGenerated : Boolean

Whether the post discloses AI-generated content (TikTok video only)

title : String

The title of the TikTok post (for photo posts)

INPUT

TwitterPostMetadataInput

Twitter post metadata

Fields 3

isAiGenerated : Boolean

Whether the post discloses AI-generated content (original tweets only, never retweets)

retweet : RetweetMetadataInput

The details of the tweet being retweeted

thread : [ThreadedPostInput!]

INPUT

UpdatePostTemplateInput

Input for an end user updating a post template. Buffer-curated taxonomy fields are ignored; setting them is only available to official Buffer clients.

Fields 6

id : PostTemplateId! Preview

The ID of the template to update.

body : String Preview

The main content body of the template, may contain {{placeholders}}.

description : String Preview

A short user-facing description of the template.

emoji : String Preview

The emoji associated with the template.

Video metadata

Fields 2

thumbnailOffset : Int

Offset of the thumbnail chosen for the video, in ms

title : String

Video title

INPUT

YoutubePostMetadataInput

Youtube post metadata

Fields 8

categoryId : String

Required on create; optional on edit (omitted preserves existing value).

embeddable : Boolean

Indicates whether the video allows embedding (default: true)

isAiGenerated : Boolean

Whether the post discloses AI-generated content

license : YoutubeLicense

Video license (default: youtube)

madeForKids : Boolean

Indicates whether the video is suitable for kids (default: false)

notifySubscribers : Boolean

Indicates whether to notify subscribers on publish video (default: true)

privacy : YoutubePrivacy

Privacy setting for post (default: public)

title : String

Title of the Youtube post. Required on create; optional on edit (omitted preserves existing value).

readUpdates

reconnectChannel

removeChannel

viewCapabilities

viewChannel

viewComments

viewInsights

viewPublish

viewUpdates Deprecated: Renamed to `viewPublish`. Still emitted for backward-compat with clients that gate on `viewUpdates`; use `viewPublish` to gate the Publish UI or `readUpdates` to gate reading post data. Will be removed once no client reads it.

ENUM

ChannelType

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

Values 6

account

business

channel

group

page

profile

ENUM

ConnectedAppCategory

The category of a connected app.

Values 1

mcp An MCP client connection.

ENUM

DateTimePresence

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

deleteNote The user can delete the note.

updateNote The user can update the note.

ENUM

NoteType

The type of a note.

Values 3

aiGenerated A note that was generated by our AI system.

bufferGenerated A note that was generated by our internal system. Can be used for approval flows notifications or other automated processes.

userGenerated A note that was manually written by a user.

ENUM

NotificationStatus

List of possible statuses for a notification

Values 2

markedAsPublished

notified

ENUM

OrganizationAction

List of possible actions that can be performed on a Organization

Values 17

createPostGroup

createPostTemplate

edit

manageAllNotes

manageBilling

manageChannelGroups

manageChannels

manageIntegrations

manageSecurityTFAEnforcement

manageTeamMembers

manageTrustedPartnerStatus

manageUploads

publishStartPages

readUploads

receiveOrganizationOwnership

transferOwnership

view

ENUM

PostAction

List of possible actions that can be performed on a Post

Values 22

addPostNote

addPostToQueue

approvePost

cancelPostRecurrence

copyPostLink

createPostRecurrence

deletePost

duplicatePost

editPostRecurrence

movePostToDraft

publishPostNext

publishPostNow

rejectPost

removePostScheduledTime

requestPostApproval

revertPostApprovalRequest

sharePostLink

updatePost

updatePostSchedule

updatePostTags

updateShopGridLink

viewPost

ENUM

PostApprovalChange

A change to a post's approval state, for a post that is already a draft.

Values 2

request Submit the draft for approval.

revert Withdraw a pending approval request, returning the post to a plain draft.

ENUM

PostingGoalStatus

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

Values 3

AtRisk

Hit

OnTrack

ENUM

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

clicks How many times people clicked on your post.

comments The count of comments and replies on your post. Unified across networks (Threads `replies` maps here).

engagementRate The percentage of people who interacted with your post compared to how many saw it. Unit: percentage.

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.

follows The number of new followers gained from this post (Instagram).

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.

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.

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.

postCount The count of posts included in an aggregated response. Only meaningful on aggregate endpoints never emitted per-post.

quotes How many times your post was quoted (Threads).

reach The number of unique people who saw your post.

reactions How many people reacted to your post. Unified across networks: Instagram/Twitter `likes`, Mastodon `favorites`, etc. all map to this value.

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.

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.

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.

reposts How many times your post was reposted by others. Twitter `retweets`, Mastodon `reblogs`, Threads `reposts` all normalize to this value.

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.

saves How many times people saved your post (Instagram, Pinterest). A strong signal that the content is worth revisiting.

shares How many times your post was shared or forwarded by others.

totalTimeWatched Total time watched, in minutes, for video-style posts (LinkedIn).

draft

error

needs_approval

scheduled

sending

sent

ENUM Preview

PostTemplateVisibility

The visibility level of a post template. public is reserved for Buffer-curated templates; setting it is only available to official Buffer clients.

Values 3

internal All members of the template's organization can access this template.

private Only the creator can access this template.

public Anyone across all organizations can access this template. Reserved for Buffer-curated templates `createPostTemplate` and `updatePostTemplate` reject this value; setting it is only available to official Buffer clients. It appears in read results.

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

carousel

event

ghost_post

offer

post

reel

short

story

thread

whats_new

ENUM

PostTypeFacebook

List of specific post types available for Facebook

Values 3

post

reel

story

ENUM

PostTypeGoogleBusiness

List of specific post types available for Google Business profiles

Values 3

event

offer

whats_new

ENUM

PostVia

List of possible ways to create a Post

Values 3

api

buffer

network

ENUM

Product

Buffer products, buffer is used as all products

Values 6

analyze

buffer

comments

engage

publish

startPage

ENUM Experimental

QueuePosition

Target position within a channel's queue that a post can be moved to.

Values 2

bottom Move the post to the bottom of the queue, taking the last slot.

top Move the post to the top of the queue, taking the next available slot.

ENUM

ScheduleOption

Values 4

Queue

Prioritize

FixedTime

Now

ENUM

SchedulingType

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

Values 2

automatic Buffer's publishing workers send the post, with nobody having to act

notification Buffer reminds someone to publish the post by hand

ENUM

Service

The list of services that can be authorized.

Values 12

bluesky

facebook

googlebusiness

instagram

mastodon

startPage

threads

tiktok

twitter

youtube

orange The standard orange palette color.

orangeLight The lighter orange palette color.

pink The standard pink palette color.

pinkLight The lighter pink palette color.

purple The standard purple palette color.

purpleLight The lighter purple palette color.

red The standard red palette color.

redLight The lighter red palette color.

teal The standard teal palette color.

tealLight The lighter teal palette color.

yellow The standard yellow palette color.

yellowLight The lighter yellow palette color.

ENUM

YoutubeLicense

List of license types

Values 2

creativeCommon

youtube

ENUM

YoutubePrivacy

List of privacy types

Values 3

private

public

unlisted

INTERFACE

Asset

Asset interface with common fields

Fields 5

id : ID

The ID of the asset in the database

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 : AssetType!

The type of the asset

INTERFACE

CommonPostMetadata

Common properties for all post metadata types

Fields 2

annotations : [Annotation!]!

Annotations representing entities in the text

text : String!

Description for the scraped link

thumbnails : [String!]!

Thumbnails of media available in the link

url : String!

URL that the link asset has been built from

INTERFACE

ThreadedPostMetadata

Common properties for all posts that support threaded replies. See ThreadedPost for more details.

Fields 2

thread : [ThreadedPost!]!

SCALAR

Uuid

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