Vendasta Social Profiles API
The Social Profiles API from Vendasta — 1 operation(s) for social profiles.
The Social Profiles API from Vendasta — 1 operation(s) for social profiles.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vendasta-social-profiles-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
title: Social Profiles API
version: Evergreen
description: These APIs allow users to use Vendasta's social capabilities. All the endpoints require either the `social` or `business` scopes to be accessed.
servers:
- url: https://prod.apigateway.co/products/social
description: Production
- url: https://demo.apigateway.co/products/social
description: Demo
- url: http://localhost:3000/products/social
description: Local
- description: Localhost
url: '{local}/products/social'
security:
- OAuth2Demo:
- business
- social
- OAuth2Prod:
- business
- social
tags:
- name: Social Profiles
paths:
/socialProfiles:
get:
summary: List Social Profiles
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/socialProfiles'
links:
type: object
properties:
self:
type: string
format: uri
first:
type: string
format: uri
description: Provides a link back to the first page of results.
next:
type: string
format: uri
description: The URI at which the next page of results can be gotten from.
operationId: get-socialProfiles
description: '[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): `Trusted Tester`
This endpoint returns Social Profile data for the given BusinessLocation. At least one filter is required to call this endpoint unless you have an existing cursor.'
parameters:
- schema:
type: string
example: AG-12345
in: query
name: filter[businessLocation.id]
description: Returns all Social Profiles for the given Business Location.
- schema:
type: string
in: query
name: page[cursor]
description: The cursor stores all your filters and current location in the list to allow paging over the results in smaller batches. The value will be provided in the response links. [Pagination Docs](https://developers.vendasta.com/platform/ZG9jOjEwMTkzMDg0-overview#paging).
- schema:
type: integer
example: 20
default: 25
in: query
name: page[limit]
description: The maximum number of Social Profiles you would like to return. [Pagination Docs](https://developers.vendasta.com/platform/ZG9jOjEwMTkzMDg0-overview#paging).
tags:
- Social Profiles
x-lifecycle:
status: trustedTester
options:
summary: List valid HTTP verbs for /socialProfiles
operationId: options-socialProfiles
description: 'Used solely for [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) the OPTIONS request returns the list of possible HTTP methods and other headers that browsers use to protect user''s security. You should not call this operation directly. '
responses:
'204':
description: No Content
tags:
- Social Profiles
x-lifecycle:
status: trustedTester
components:
schemas:
socialProfiles:
title: Social Profiles
type: object
description: '[Status](https://developers.vendasta.com/platform/ZG9jOjEwMTU2NTYy-versioning): `Trusted Tester`
An entity that contains the information of a connected account or page with a social network.'
x-tags:
- Social Profiles
x-lifecycle:
status: trustedTester
properties:
type:
type: string
default: socialProfiles
id:
type: string
example: FBU-117641035298609261021
description: The unique id for this Social Profile.
attributes:
type: object
properties:
name:
type: string
example: John's Delivery
description: The name of this profile.
avatarUrl:
type: string
description: The link to an url for the avatar image of this profile.
socialNetwork:
type: string
description: A string enum representing which social network this Social Profile is on.
enum:
- facebook
- twitter
- gmb
- linkedinCompany
- linkedinUser
- instagram
status:
type: string
description: A string enum that describes the current state of this Social Profile. This may include possibilities like needing user reauthentication, or being disabled due to edition changes.
enum:
- disabled
- active
- authorizationRequired
statusReason:
type: string
description: If status is not ACTIVE, this will be filled with a string describing steps to fix this. Currently only in proposed stage.
relationships:
type: object
properties:
businessLocation:
type: object
description: The business location that is allowed to post to this socialProfile.
properties:
data:
type: object
properties:
type:
type: string
default: businessLocations
readOnly: true
id:
type: string
example: AG-12AB5
required:
- type
- id
required:
- businessLocation
required:
- type
securitySchemes:
JWT:
type: http
scheme: bearer
bearerFormat: JWT
OAuth2Demo:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://sso-api-demo.apigateway.co/oauth2/auth
tokenUrl: https://sso-api-demo.apigateway.co/oauth2/token
scopes:
business: Read-write access to business details
social: Read-write access to Social AI APIs
OAuth2Prod:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://sso-api-prod.apigateway.co/oauth2/auth
tokenUrl: https://sso-api-prod.apigateway.co/oauth2/token
scopes:
business: Read-write access to business details
social: Read-write access to Social AI APIs