Skip to content

Social-Planner.md

Latest commit

 

History

History
1713 lines (1434 loc) · 35 KB

Social-Planner.md

File metadata and controls

1713 lines (1434 loc) · 35 KB

Social Planner API

Source: HighLevel API 2.0 Documentation Crawled: 2026-03-25

Table of Contents

Source: https://marketplace.gohighlevel.com/docs/ghl/social-planner/

404

Page Not Found

The page you are looking for doesn't exist or has been moved.

Go to Home Go Back

reCAPTCHA

Recaptcha requires verification.

Privacy - Terms

protected by reCAPTCHA

Privacy - Terms

Get Account

Source: https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-account/index.html

Skip to main content

Get Accounts

GET https://services.leadconnectorhq.com/social-media-posting/:locationId/accounts

Get list of accounts and groups

Requirements

Scope(s)

socialplanner/account.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Example: 2021-07-28

Path Parameters

locationId stringrequired

Location Id

Example: ve9EPM428h8vShlRW1KT

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

success booleanrequired

Success or Failure

Example:true

statusCode numberrequired

Status Code

Example:200

message stringrequired

Message

Example:Fetched Accounts

results object

Requested Results

accounts object[]

Array of connected social media accounts

Array [

id string

Unique identifier for the connected account

Example:aF3KhyL8JIuBwzK3m7Ly_Lx1EI6YIgQYMQi0ytFXv_12554616564525983496

oauthId string

OAuth provider account identifier

Example:aF3KhyL8JIuBwzK3m7Ly

profileId string

Profile identifier from the social media platform

Example:aF3KhyL8JIuBwzK3m7Ly

name string

Display name of the account

Example:Sample Account

platform string

platform must be one of the following values: google, facebook, instagram, linkedin, tiktok

Example:google

type string

Type of account (e.g., location, page, profile)

Example:location

expire string

Token expiration date and time

Example:2024-03-11T19:29:59.785Z

isExpired boolean

Indicates if the account token has expired

Example:false

meta object

Additional metadata for the account

Example:{"hasGoogleUpdated":true,"canDelete":true}

]

groups object[]

Array of account groups

Array [

id stringrequired

Group Id

Example:6284c43d519161e96cc09c13

name stringrequired

name of group

Example:Primary

accountIds string[]required

Array of account IDs belonging to this group

Example:["6494063f4260855c1c5776b5_mhoUgTPkz19vjF5Qu7Av_2774080328752823730"]

]

{
  "success": true,
  "statusCode": 200,
  "message": "Fetched Accounts",
  "results": {
    "accounts": [\
      {\
        "id": "aF3KhyL8JIuBwzK3m7Ly_Lx1EI6YIgQYMQi0ytFXv_12554616564525983496",\
        "name": "Sample Account",\
        "platform": "google"\
      }\
    ],
    "groups": [\
      {\
        "id": "6284c43d519161e96cc09c13",\
        "name": "Primary"\
      }\
    ]
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: socialplanner/account.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/social-media-posting/:locationId/accounts' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Posts

Source: https://marketplace.gohighlevel.com/docs/ghl/social-planner/get-posts/index.html

Skip to main content

Get posts

POST https://services.leadconnectorhq.com/social-media-posting/:locationId/posts/list

Get Posts

Requirements

Scope(s)

socialplanner/post.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Example: 2021-07-28

Path Parameters

locationId stringrequired

Location Id

Example: ve9EPM428h8vShlRW1KT

  • application/json

Body required

type string

type must be one of the following values: recent, all, scheduled, draft, failed, in_review, published, in_progress, pending and deleted

Default value: all

Example:all

accounts string

List of account Ids separated by comma as a string

Example:660a83fc29deacac50033e2b_omaDY3RbWtTP511e808O_17841465964543589, 38bF83fc29deacac50033e2b_omaDY3RbWtr3P11e808O_17841465964543998

skip stringrequired

Number of records to skip for pagination

Default value: 0

Example:0

limit stringrequired

Maximum number of records to return

Default value: 10

Example:10

fromDate stringrequired

From Date

Example:2024-01-22T05:32:49.463Z

toDate stringrequired

To Date

Example:2024-03-20T05:32:49.463Z

includeUsers stringrequired

Include User Data

Example:true

postType object

Post Type must be one of the following values: - post, story, reel

Example:post

Responses ​

  • 201
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

success booleanrequired

Success or Failure

Example:true

statusCode numberrequired

Status Code

Example:201

message stringrequired

Message

Example:Fetched Posts

results object

Requested Results

posts object[]

Post Data

Array [

_id string

MongoDB document ID of the post

Example:61bb16833b3f2791f9715be2

source string

source must be one of the following values: composer, recurring, csv

Possible values: [composer, csv, recurring, review, rss]

Example:composer

locationId stringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

platform string

platform must be one of the following values: google, facebook, instagram, linkedin, twitter, tiktok

Example:google

displayDate date-time

Display date for the post

Example:2023-08-02T00:00:00.000Z

createdAt date-time

Date when the post was created

Example:2023-08-02T00:00:00.000Z

updatedAt date-time

Date when the post was last updated

Example:2023-08-02T00:00:00.000Z

accountId string

Account Id

Example:w37swmmLbA02zgqKPpxITe

error stringrequired

Error

Example:Failed due to auth token

postId string

Platform-specific post identifier

Example:323534534435

publishedAt string

Date when the post was published

Example:2021-06-22T05:32:49.463Z

accountIds string[]

Account Ids

Example:["aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496"]

summary string

Content text of the post

Example:Sample Summary

media object[]

Post Media Data
The limitations of media as per the platforms is provided through the reference link in API description

Array [

url stringrequired

Public URL of the media file. Must be a valid, accessible HTTPS URL.

Example:https://storage.googleapis.com/your-bucket/media/image.jpg

caption string

Alt text or caption for the media. Used for accessibility and SEO.

Example:Team meeting discussing Q4 marketing strategy

originalUrl string

Original media URL before any processing (watermarking/optimization). Set automatically by the system.

Example:https://storage.googleapis.com/test/test/media/original.jpeg

watermarkedUrl string

URL of the media after watermarking. Set automatically when watermark is applied.

Example:https://storage.googleapis.com/test/test/media/watermarked.jpeg

type stringrequired

MIME type of the media file. See Platform Limitations Guide for platform-specific format support.

Possible values: [image/jpeg, image/jpg, image/png, image/gif, video/mp4, video/mov, video/webm]

Example:image/jpeg

thumbnail string

URL of the video thumbnail image. Used for video preview before playback.

Tip: For videos, providing a custom thumbnail improves engagement.

Example:https://storage.googleapis.com/your-bucket/media/video-thumbnail.jpeg

defaultThumb string

Default thumbnail URL, auto-generated from video if not provided.

Example:https://storage.googleapis.com/test/test/media/default-thumb.jpeg

id string

Unique identifier for the media item. Used for tracking and referencing.

Example:media_abc123xyz

optimizedUrl string

URL of the optimized/compressed media. Set automatically when media optimization is enabled.

Enable Optimization: Set mediaOptimization: true in the post request.

Example:https://storage.googleapis.com/your-bucket/media/optimized-image.jpg

optimizedType string

MIME type of the optimized media. May differ from original if format conversion occurred.

Example:image/jpeg

isModified boolean

Flag indicating if the media was modified (watermarked, optimized, or processed).

Example:true

]

status object

Status must be one of the following values: in_progress, draft, failed, published, scheduled, in_review, notification_sent, deleted

Example:published

createdBy string

User ID who created the post

Example:Lx1EI6YIgQYMQi0ytFXv

type objectrequired

Post Type must be one of the following values: - post, story, reel

Example:post

tags string[]

Tag Ids

Example:["aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496"]

ogTagsDetails object

Og Tags Meta Data

metaImage string

Preview image URL for the shared link.

Best Practices:
\

  • Use high-quality images (1200x630px recommended)\
  • Ensure the image is publicly accessible

    Auto-fetch: Use the Get Metatags API to fetch OG data from a URL.

    Example:https://yoursite.com/images/og-image.jpg

    metaLink string

    URL of the webpage being shared. This is the destination when users click the link preview.

    Example:https://yoursite.com/blog/amazing-article

    ogTitle string

    Custom title for the link preview. Overrides the page's og:title meta tag.

    Tip: Keep titles concise (50-60 characters) for best display across platforms.

    Example:How to Double Your Social Media Engagement

    ogDescription string

    Custom description for the link preview. Overrides the page's og:description meta tag.

    Tip: Keep descriptions under 155 characters for optimal display.

    Example:Learn proven strategies to boost your social media engagement and grow your audience.

    postApprovalDetails object

    Post Approval Details

    approver string

    User ID of the designated approver.

    Note: The approver will receive a notification when a post is submitted for review.

    Example:iVrVJ2uoXNF0wzcBzgl5

    requesterNote string

    Note from the post creator to the approver explaining the post or requesting specific feedback.

    Example:Please review the messaging for our Q4 campaign launch. Let me know if the CTA needs adjustment.

    approverNote string

    Note from the approver to the post creator with feedback or approval comments.

    Example:Approved! Great content. Consider adding more hashtags for visibility.

    approvalStatus string

    Current approval status of the post.

    Available Values:
    \
  • pending - Awaiting approver review\
  • approved - Approved and ready for publishing\
  • rejected - Rejected by approver (needs revision)\
  • not_required - No approval workflow needed

    Possible values: [pending, approved, rejected, not_required]

    Example:pending

    approverUser object

    Approver User Details

    id stringrequired

    User Id

    Example:6284c43d519161e96cc09c13

    title stringrequired

    Title

    Example:Mr

    firstName stringrequired

    First name

    Example:Harry

    lastName stringrequired

    Last name

    Example:Spencer

    profilePhoto stringrequired

    Profile photo

    Example:https://storage.googleapis.com/user/kCrjKGHZQ2/profile/1dca8c-61c9-404d-a459-751fbcb.jpeg

    phone stringrequired

    Phone number

    Example:901111119

    email stringrequired

    Email Id

    Example:abc@xyc.com

    tiktokPostDetails object

    Tiktok Post Details

    privacyLevel stringrequired

    Privacy level controlling who can view the video.

    Available Values:
    \
  • PUBLIC_TO_EVERYONE - Anyone can view (default)\
  • MUTUAL_FOLLOW_FRIENDS - Only mutual followers can view\
  • SELF_ONLY - Only you can view (private)

    Note: If set to SELF_ONLY, videoDisclosure must be false.

    Possible values: [PUBLIC_TO_EVERYONE, MUTUAL_FOLLOW_FRIENDS, SELF_ONLY]

    Example:PUBLIC_TO_EVERYONE

    promoteOtherBrand boolean

    Indicates if the video promotes a third-party brand or product.

    Required: Must be true if videoDisclosure is enabled and you're promoting another brand.

    Example:false

    enableComment boolean

    Allow users to comment on the video. Default is determined by account settings.

    Example:true

    enableDuet boolean

    Allow users to create Duet videos with your content.

    Duet: Side-by-side video featuring your content and the creator's reaction/addition.

    Example:true

    enableStitch boolean

    Allow users to create Stitch videos with your content.

    Stitch: Clips up to 5 seconds of your video that creators can use in their own videos.

    Example:true

    videoDisclosure boolean

    Enable branded content disclosure. Required when video is promotional content.

    Validations:
    \
  • Cannot be true if privacyLevel is SELF_ONLY\
  • If enabled, at least one of promoteYourBrand or promoteOtherBrand must be true

    Example:false

    promoteYourBrand boolean

    Indicates if the video promotes your own brand or product.

    Required: Must be true if videoDisclosure is enabled and you're promoting your own brand.

    Example:false

    gmbPostDetails object

    GMB Post Details

    gmbEventType stringrequired

    Google My Business post type.

    Available Types:
    \
  • STANDARD - Regular update post (What's New)\
  • EVENT - Event announcement with dates and title\
  • OFFER - Promotional offer with coupon and redemption details

    Required fields by type:
    \
  • STANDARD: None additional\
  • EVENT: title, startDate, endDate\
  • OFFER: offerTitle, startDate, endDate, termsConditions, couponCode, redeemOnlineUrl

    Possible values: [STANDARD, EVENT, OFFER]

    Example:STANDARD

    title string

    Event title. Required when gmbEventType is EVENT.

    Max length: 58 characters

    Example:Summer Sale Event 2024

    offerTitle string

    Offer title. Required when gmbEventType is OFFER.

    Example:50% Off All Products

    startDate object

    Start date and time for EVENT or OFFER posts.

    Required: When gmbEventType is EVENT or OFFER.

    Structure:
    \
  • startDate: { year, month, day }\
  • startTime: { hours, minutes, seconds }

    startDate object

    Start Date

    year numberrequired

    Year component of the date

    Example:2022

    month numberrequired

    Month component of the date (1-12)

    Example:1

    day numberrequired

    Day component of the date (1-31)

    Example:1

    startTime object

    Start Time

    hours numberrequired

    Hour component of the time (0-23)

    Example:23

    minutes numberrequired

    Minute component of the time (0-59)

    Example:56

    seconds numberrequired

    Second component of the time (0-59)

    Example:34

    endDate object

    End date and time for EVENT or OFFER posts.

    Required: When gmbEventType is EVENT or OFFER.
    Validation: Must be after startDate.

    Structure:
    \
  • endDate: { year, month, day }\
  • endTime: { hours, minutes, seconds }

    endDate object

    End Date

    year numberrequired

    Year component of the date

    Example:2022

    month numberrequired

    Month component of the date (1-12)

    Example:1

    day numberrequired

    Day component of the date (1-31)

    Example:1

    endTime object

    End Time

    hours numberrequired

    Hour component of the time (0-23)

    Example:23

    minutes numberrequired

    Minute component of the time (0-59)

    Example:56

    seconds numberrequired

    Second component of the time (0-59)

    Example:34

    termsConditions string

    URL to terms and conditions page. Required for OFFER posts.

    Example:https://yoursite.com/terms-and-conditions

    url string

    Call-to-action URL. Required when actionType is set (except none and call).

    Required for: STANDARD and EVENT posts with actionType other than none or call.

    Example:https://yoursite.com/book-now

    couponCode string

    Promotional coupon code. Required for OFFER posts.

    Example:SAVE50

    redeemOnlineUrl string

    URL where customers can redeem the offer online. Required for OFFER posts.

    Example:https://yoursite.com/redeem-offer

    actionType string

    Call-to-action button type for the post.

    Available Actions:
    \
  • none - No action button\
  • order - Order online\
  • book - Book appointment\
  • shop - Shop now\
  • learn_more - Learn more\
  • call - Call now (no URL required)\
  • sign_up - Sign up

    Note: All actions except none and call require a url.

    Possible values: [none, order, book, shop, learn_more, call, sign_up]

    Example:book

    blueskyPostDetails object

    Bluesky Post Details

    shortenedLinks string[]

    Shortened links for the post (auto-generated).

    replyTo string

    Bluesky AT Protocol URI of a post to reply to.

    Format:at://did:plc:{user-id}/app.bsky.feed.post/{post-id}

    Use Case: Create a reply thread to an existing Bluesky post.

    Example:at://did:plc:abc123def456/app.bsky.feed.post/xyz789

    quotePost string

    Bluesky AT Protocol URI of a post to quote.

    Format:at://did:plc:{user-id}/app.bsky.feed.post/{post-id}

    Use Case: Quote-post another user's post with your commentary.

    Example:at://did:plc:abc123def456/app.bsky.feed.post/xyz789

    language string

    ISO 639-1 language code for the post content.

    Examples:en (English), es (Spanish), fr (French), de (German)

    Example:en

    externalLink string

    External URL to embed as a link card in the post.

    Example:https://yoursite.com/article

    externalLinkTitle string

    Title for the external link card. Displayed prominently in the embed.

    Example:10 Tips for Better Social Media Marketing

    externalLinkDescription string

    Description for the external link card. Brief summary displayed below the title.

    Example:Learn how to improve your social media presence with these proven strategies.

    user object

    User

    id stringrequired

    User Id

    Example:6284c43d519161e96cc09c13

    title stringrequired

    Title

    Example:Mr

    firstName stringrequired

    First name

    Example:Harry

    lastName stringrequired

    Last name

    Example:Spencer

    profilePhoto stringrequired

    Profile photo

    Example:https://storage.googleapis.com/user/kCrjKGHZQ2/profile/1dca8c-61c9-404d-a459-751fbcb.jpeg

    phone stringrequired

    Phone number

    Example:901111119

    email stringrequired

    Email Id

    Example:abc@xyc.com

    linkedinPostDetails object

    Linkedin Post Details

    pdfTitle stringrequired

    Title for the PDF document carousel. Displayed as the document name on LinkedIn.

    Max length: 100 characters

    Tip: Use a descriptive title that explains the document content.

    Example:Q4 Marketing Strategy Presentation

    postAsPdf booleanrequired

    Post images as a PDF document carousel.

    Limits:
    \
  • Max 300 pages/images\
  • Max PDF size: 100 MB

    Example:true

    pinterestPostDetails object

    Pinterest Post Details

    title string

    Pin title displayed on Pinterest.

    Max length: 100 characters

    Best Practices:
    \
  • Include relevant keywords\
  • Be descriptive and engaging

    Example:10 Easy Home Decor Ideas for 2024

    link string

    Destination URL for the pin. Users clicking the pin will be directed to this URL.

    Max length: 2048 characters

    Best Practices:
    \
  • Use direct links to relevant content\
  • Track with UTM parameters for analytics

    Example:https://yoursite.com/blog/home-decor-ideas

    boardIds objectrequired

    Mapping of Pinterest account OAuth IDs to their respective board IDs.

    Structure:{ accountOAuthId: boardId }

    Get Board IDs from: Get Pinterest Boards API — use the id field from each board.

    Create Boards: Create Pinterest Board API to create new boards.

    Required: Each Pinterest account in the post must have a corresponding board ID.

    property name* string

    shortenedLinks string[]

    Shortened links for the post (auto-generated).

    facebookPostDetails object

    Facebook Post Details

    type stringrequired

    Facebook post format type.

    Available Types:
    \
  • post - Standard feed post (images, videos, text)\
  • story - 24-hour temporary story\
  • reel - Short-form vertical video

    Restrictions:
    \
  • Reels: Require exactly 1 video, not supported on Groups\
  • Stories: Captions not supported

    Possible values: [post, story, reel]

    Example:post

    instagramPostDetails object

    Instagram Post Details

    type stringrequired

    Instagram post format type.

    Available Types:
    \
  • post - Standard feed post (images, videos, carousels)\
  • story - 24-hour temporary story\
  • reel - Short-form vertical video (up to 90 seconds)

    Restrictions:
    \
  • Media is REQUIRED for all Instagram posts\
  • Reels: Require exactly 1 video\
  • Stories: Captions not supported, JPEG only for images

    Possible values: [post, story, reel]

    Example:post

    collaborators object

    Object mapping account IDs to arrays of associated usernames for collaboration. Only allowed for type "post" and "reels"

    Example:{"accountId1":["username1","username2"],"accountId2":["username3","username4"]}

    showOnFeed boolean

    Show Reel on profile grid/feed.

    ✅ Applies to: Reels only
    \
  • true - Reel appears on your profile grid\
  • false - Reel only appears in Reels tab

    Example:true

    publishViaPushNotification boolean

    Send Instagram Story via Push Notification instead of direct posting. Only applicable for Story type.

    Example:true

    publisherNote string

    Note to the publisher for manual posting guidance. Only used when publishViaPushNotification is true.

    Example:When publishing, add swipe up link to the landing page so that we can direct them to the sales page

    youtubePostDetails object

    Youtube Post Details

    title string

    Video title displayed on YouTube.

    Max length: 100 characters

    Best Practices:
    \
  • Include relevant keywords\
  • Be descriptive but concise\
  • Avoid clickbait

    Example:How to Build a Successful Marketing Strategy in 2024

    privacyLevel string

    Video visibility/privacy setting.

    Available Values:
    \
  • public - Anyone can search and view\
  • unlisted - Only people with the link can view\
  • private - Only you can view

    Possible values: [private, public, unlisted]

    Example:public

    type stringrequired

    YouTube video format type.

    Available Types:
    \
  • video - Standard YouTube video (landscape, any duration)\
  • short - YouTube Shorts (vertical, up to 60 seconds)

    Required field.

    Possible values: [video, short]

    Example:video

    communityPostDetails object

    Community Post Details

    title stringrequired

    Title of the community post. Displayed as the post headline.

    Max length: 1,000 characters

    Required: Yes, for all Community posts.

    Example:Welcome to Our New Community Feature!

    notifyAllGroupMembers booleanrequired

    Send push notification to all group members when the post is published.

    Use Case: Enable for important announcements to ensure all members are notified.

    Example:true

    postAsUser objectrequired

    Mapping of Community account OAuth IDs to user details for posting on behalf of users.

    Structure:{ accountOAuthId: { id, name, avatar } }
    \
  • id (required): User ID within the Community group\
  • name (optional): Display name for the post author\
  • avatar (optional): Profile image URL

    Get Account OAuth IDs from: Get Accounts API — use the oAuthId field from Community accounts.

    Required: Yes, each Community account in accountIds must have a corresponding entry here.

    Example:{"xMQswA02zgqKPpxITe":{"avatar":"https://lh3.googleusercontent.com/a/user-avatar.jpg","id":"snCr14eeYkSppD04rkNW","name":"John Smith"}}

    mediaOptimization boolean

    Pass this parameter to optimize the image media

    Example:true

    ]

count number

Total count of posts

Example:6

{
  "success": true,
  "statusCode": 201,
  "message": "Fetched Posts",
  "results": {
    "posts": [\
      {\
        "_id": "61bb16833b3f2791f9715be2",\
        "locationId": "ve9EPM428h8vShlRW1KT",\
        "status": "published"\
      }\
    ],
    "count": 6
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: socialplanner/post.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/social-media-posting/:locationId/posts/list' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "type": "all",
  "accounts": "660a83fc29deacac50033e2b_omaDY3RbWtTP511e808O_17841465964543589, 38bF83fc29deacac50033e2b_omaDY3RbWtr3P11e808O_17841465964543998",
  "skip": "0",
  "limit": "10",
  "fromDate": "2024-01-22T05:32:49.463Z",
  "toDate": "2024-03-20T05:32:49.463Z",
  "includeUsers": "true",
  "postType": "post"
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

locationId — pathrequired

Version — headerrequired

---2021-07-28

Body required

{
  "type": "all",
  "accounts": "660a83fc29deacac50033e2b_omaDY3RbWtTP511e808O_17841465964543589, 38bF83fc29deacac50033e2b_omaDY3RbWtr3P11e808O_17841465964543998",
  "skip": "0",
  "limit": "10",
  "fromDate": "2024-01-22T05:32:49.463Z",
  "toDate": "2024-03-20T05:32:49.463Z",
  "includeUsers": "true",
  "postType": "post"
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Oauth Facebook

Source: https://marketplace.gohighlevel.com/docs/ghl/social-planner/oauth-facebook/index.html

Skip to main content

Documentation for Social Media Posting API

📄️ Starts OAuth For Facebook Account \ Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Facebook login OAuth screen. On successful login, listen on window object for message where event listener returns data in its callback function.📄️ Get facebook pages \ Get facebook pages📄️ Attach facebook pages \ Attach facebook pages

Oauth Google

Source: https://marketplace.gohighlevel.com/docs/ghl/social-planner/oauth-google/index.html

Skip to main content

Documentation for Social Media Posting API

📄️ Starts OAuth For Google Account \ Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Google login OAuth screen. On successful login, listen on window object for message where event listener returns data in its callback function.📄️ Get google business locations \ Get google business locations📄️ Set google business locations \ Set google business locations

Post

Source: https://marketplace.gohighlevel.com/docs/ghl/social-planner/post/index.html

Skip to main content

Documentation for Social Media Posting API

📄️ Get posts \ Get Posts📄️ Create post \ Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitting the create post API multiple times with different summaries and account IDs per platform.📄️ Get post \ Get post📄️ Edit post \ Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitting the create post API multiple times with different summaries and account IDs per platform.📄️ Delete Post \ Delete Post📄️ Bulk Delete Social Planner Posts \ Deletes multiple posts based on the provided list of post IDs.

Social Media Posting Api

Source: https://marketplace.gohighlevel.com/docs/ghl/social-planner/social-media-posting-api/index.html

Skip to main content

Version: 1.0

Social Media Posting API

Documentation for Social Media Posting API

Authentication ​

  • HTTP: Bearer Auth
  • HTTP: Bearer Auth
  • HTTP: Bearer Auth

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |

Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.

| Security Scheme Type: | http | | HTTP Authorization Scheme: | bearer | | Bearer format: | JWT |