Retrieves the authenticated user's account information
Buffer GraphQL API
Complete API reference documentation
Account
Queries 1
Outputs 1
Types 2
Enums 1
Scalars 2
Channels
Queries 2
Fetches a single channel using the provided ID
Arguments
| Name | Type | Description |
|---|---|---|
| input | ChannelInput! | Query's input. |
Fetch all channels for the organization taking into account the current's user permissions
Arguments
| Name | Type | Description |
|---|---|---|
| input | ChannelsInput! | Query's input. |
Outputs 1
Types 17
BlueskyMetadata
Bluesky metadata
ChannelLinkShortening
Settings for link shortening
FacebookMetadata
Facebook metadata
GoogleBusinessMetadata
Google Business metadata
IdeaMedia
Media attached to an idea
IdeaMediaSource
Media source for the idea, e.g. Unsplash, Gifphy, etc.
LinkedInMetadata
LinkedIn metadata
LinkShorteningConfig
Link Shortening Configuration
LocationData
Location data about the channel
MastodonMetadata
Mastodon metadata
PinterestBoard
A Pinterest board
PinterestMetadata
Pinterest metadata
ScheduleV2
Posting schedule for a specific day of the week
TiktokMetadata
Tiktok metadata
TwitterMetadata
Twitter metadata
YoutubeMetadata
Youtube metadata
ChannelMetadata
Metadata or settings about the channel depending on the service type
Inputs 5
ChannelInput
Input for the channel query
ChannelsFiltersInput
Filter to pass when fetching channels.
ChannelsInput
Input to pass when fetching channels.
IdeaMediaInput
IdeaMediaSourceInput
Input type for the source information of media attached to an idea
Enums 6
ChannelAction
List of possible actions that can be performed on a Channel
ChannelType
Channel is a representation of a social media account or page that can be connec...
DayOfWeek
MediaType
The type of media attached to a post
Product
Buffer products, buffer is used as all products
Service
The list of services that can be authorized.
Scalars 1
Posts
Queries 2
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 | PostInput! | Query's input. |
Fetches posts for the given organization: first and last can be set for forward pagination using Relay convention
Arguments
| Name | Type | Description |
|---|---|---|
| input | PostsInput! | Query's input. |
| first | Int | The number of posts to return |
| after | String | The cursor of the post to start fetching from |
Mutations 1
Create post for channel
Arguments
| Name | Type | Description |
|---|---|---|
| input | CreatePostInput! | The mutation's input |
Outputs 3
Post
Post entity
PostsResults
Results for the posts query.
PostActionPayload
Create post's request response payload.
Types 42
Annotation
Annotation representing all the entities in the text
Author
Represent the author of a post or note.
BlueskyPostMetadata
Bluesky post metadata
FacebookPostMetadata
Facebook post metadata
GoogleBusinessEventMetaData
Metadata for a GBP post that is an event
GoogleBusinessOfferMetaData
Metadata for a GBP post that is an offer
GoogleBusinessPostMetadata
Google Business Profile post metadata
@deprecated: pending proposal for specific...
GoogleBusinessWhatsNewMetaData
Metadata for a GBP post of type Whats new
InstagramGeolocation
Instagram Geolocation
InstagramMetadata
Instagram metadata
InstagramPostMetadata
Instagram post metadata
InstagramStickerFields
Instagram fields for reminder-based publishing. Upon the reminder for publishing...
LinkAttachment
Link attachment
LinkedInPostMetadata
LinkedIn post metadata
MastodonPostMetadata
Mastodon post metadata
Note
Note entity
NotFoundError
Error returned when the resource is not found
PaginationPageInfo
Information to aid in pagination.
PinterestPostMetadata
Pinterest post metadata
PostActionSuccess
Success response returns the full up-to-date post from after the action was perf...
PostingGoal
Represents a posting goal for a channel, including target, progress, and status...
PostPublishingError
Post publishing error
PostsEdge
Represent a node in the pagination result using the Connect Relay convention.
PublishingTag
Tag associated with a post
RestProxyError
Error proxied from the REST API response
RetweetMetadata
Information about the initial Tweet that was retweeted
RetweetUserMetadata
Information about the initial author of the Tweet that was retweeted
StartPagePostMetadata
Start Page post metadata
Tag
Tag entity
ThreadedPost
A post authored by the user which is posted to a thread.
This is commonly used f...
ThreadsPostMetadata
Threads post metadata
TiktokPostMetadata
Tiktok post metadata
TwitterPostMetadata
Twitter post metadata
UserTag
User tag in the image
WeeklyPostingLimit
Weekly posting limit for a channel
YoutubeCategory
YoutubePostMetadata
Youtube post metadata
Asset
Asset interface with common fields
CommonPostMetadata
Common properties for all post metadata types
ThreadedPostMetadata
Common properties for all posts that support threaded replies.
See ThreadedPost...
GoogleBusinessPostDetails
GoogleBusiness Metadata details
PostMetadata
Post metadata union type. Contains all possible types of post metadata.
Inputs 40
AnnotationInputFacebook
Annotation representing all the entities in the text
AnnotationInputLinkedIn
Annotation representing all the entities in the text
AssetsInput
Asset interface with common fields
BlueskyPostMetadataInput
Bluesky post metadata
CreatePostInput
Create post's request input.
DateTimeComparator
Comparator for filtering by date
DocumentAssetInput
Document asset
FacebookPostMetadataInput
Facebook post metadata
GoogleBusinessEventMetaDataInput
Metadata for a GBP post that is an event
GoogleBusinessOfferMetaDataInput
Metadata for a GBP post that is an offer
GoogleBusinessPostMetadataInput
Google Business Profile post metadata
@deprecated: pending proposal for specific...
GoogleBusinessWhatsNewMetaDataInput
Metadata for a GBP post of type Whats new
ImageAssetInput
Image asset
ImageDimensionsInput
Image dimensions
ImageMetadataInput
Image metadata
InstagramGeolocationInput
Instagram Geolocation
InstagramPostMetadataInput
Instagram post metadata
InstagramStickerFieldsInput
Instagram fields for reminder-based publishing. Upon the reminder for publishing...
LinkAssetInput
Link attached to the post
LinkAttachmentInput
Link attachment
LinkedInPostMetadataInput
LinkedIn post metadata
MastodonPostMetadataInput
Mastodon post metadata
PinterestPostMetadataInput
Pinterest post metadata
PostInput
Input for the post query
PostInputMetaData
Metadata of the post which differs based on the social network/service
PostsFiltersInput
Filter to apply to the posts query
PostsInput
Input for the posts query
PostSortInput
Sort order of post results. List multiple to create tie-breaking order.
RetweetMetadataInput
Information about the initial Tweet that was retweeted
StartPagePostMetadataInput
Start Page post metadata
TagComparator
Comparator for filtering by tags
TagInput
Input type for tag information used in idea creation
ThreadedPostInput
A post authored by the user which is posted to a thread.
This is commonly used f...
ThreadsPostMetadataInput
Threads post metadata
TikTokPostMetadataInput
TikTok post metadata
TwitterPostMetadataInput
Twitter post metadata
UserTagInput
User tag in the image
VideoAssetInput
Video asset
VideoMetadataInput
Video metadata
YoutubePostMetadataInput
Youtube post metadata
Enums 19
AnnotationType
List of possible types for an annotation
AssetType
Asset types
GoogleBusinessPostActionType
List of possible types for GBP cta
NoteAction
List of possible actions that can be performed on a note
NoteType
The type of a note.
NotificationStatus
List of possible statuses for a notification
PostAction
List of possible actions that can be performed on a Post
PostingGoalStatus
PostingGoalStatus is used to track the status of a posting goal.
PostSortableKey
Key of collection to use for sorting
PostStatus
List of possible statuses for a Post
PostType
List of possible types for a Post. Some services may have different types (e.g.,...
PostTypeFacebook
List of specific post types available for Facebook
PostTypeGoogleBusiness
List of specific post types available for Google Business profiles
PostVia
List of possible ways to create a Post
SchedulingType
Indicates whether the post was scheduled for notification publishing or automati...
ShareMode
How the post is being scheduled.
SortDirection
Direction to sort the results by.
YoutubeLicense
List of license types
YoutubePrivacy
List of privacy types
Scalars 4
DraftId
The `DraftId` scalar represents the MongoDB ObjectId of a Buffer Draft
NoteId
The `NoteId` scalar represents the MongoDB ObjectId of a Buffer Note
PostId
The `PostId` scalar represents the MongoDB ObjectId of a Buffer Post
TagId
The `TagId` scalar represents the MongoDB ObjectId of a Buffer Tag
Ideas
Mutations 1
Create a new idea with the given content and metadata
Arguments
| Name | Type | Description |
|---|---|---|
| input | CreateIdeaInput! | Input to create an idea |
Outputs 1
Types 7
Idea
Ideas are the main entity in the create space
IdeaContent
Content of an idea
IdeaResponse
createIdea response type
InvalidInputError
Error returned when the input is invalid
LimitReachedError
Error returned when the limit is reached
UnauthorizedError
Error returned when the user is not authorized to perform the action
UnexpectedError
Error returned when unexpected error occurs
Inputs 3
CreateIdeaInput
createIdea input type
IdeaContentInput
content input for creating/updating an idea
IdeaGroupInput
idea group input for create/update
Scalars 1
Organizations
Types 3
MemberConnection
Represents the members connection edge. Later, we can add the list of members wi...
Organization
Organization is a representation of a Buffer Organization.
OrganizationLimits
Resource limits for an organization including channels, members, and content lim...
Inputs 1
Enums 1
Scalars 1
Other
Types 9
DocumentAsset
Document asset
DocumentMetadata
Document metadata
ImageAsset
Image asset
ImageMetadata
Image metadata
VideoAsset
Video asset
VideoMetadata
Video metadata
VoidMutationError
Error implementation that allows clients to resolve the MutationError on mutatio...
MutationError
Base Mutation Error type
ScrapedLink
Link data for link preview
Directives 1
@oneOf
Indicates exactly one field must be supplied and this field must not be null.
Locations: INPUT_OBJECT