accounts

Get social accounts

Get social accounts list for the current organization paginated

get/organizations/{id_organization}/accounts

Request

  • Base URL: https://api.planvortex.com/v1.0.0
  • URL: https://api.planvortex.com/v1.0.0/organizations/{id_organization}/accounts
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.planvortex.com/v1.0.0/oauth/token)

Path parameters

id_organizationstring required

Organization identifier

Query parameters

offsetinteger

Number of records from which you will get roles (pagination)

limitinteger

The limit of records will be retrieved (pagination)

namestring

Free-text search over the account's name and username.

accountsstring[]

Only these accounts, by identifier. Repeat the parameter for more than one.

social_networkSocialNetwork[]

Only accounts of these networks. Repeat the parameter for more than one.

capability'publications' | 'messages' | 'products' | 'webhooks' | 'persistent_menu' | 'comments'

Only accounts whose network can do this. It is the same matrix GET /social_capabilities publishes, applied server-side: the way to ask for 'the accounts I can publish with' without keeping your own table of which network does what.

comments also looks at each account, not only at its network: a LinkedIn personal profile is left out, because only LinkedIn pages have a comment inbox. total counts the same way.

Response

Successful operation

totalinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.