Oktopost
Account

Social Profiles

View and manage connected social media accounts, including personal profiles, company pages, and groups.

Social profiles are the social media accounts connected to Oktopost, including personal profiles, company pages, and groups from networks like LinkedIn, X, Facebook, Instagram, and YouTube. These profiles serve as the publishing destinations for your posts and the sources for engagement data. Use these endpoints to retrieve profile information, check connection status, and manage your connected accounts.

Social profiles must be connected through the Oktopost platform interface before they can be accessed via the API. Use these endpoints to retrieve and manage profiles that are already connected.

Get Social Profile

Get a single social profile by Id.

Example Request

curl -i https://api.oktopost.com/v2/credential/003-001000000000000-10795428XXXXXXXXX

Example Result

{
    "Result":true,
    "Credential":{
        "Id":"003-001000000000000-10795428XXXXXXXXX",
        "Created":"2015-10-26 21:02:30",
        "Name":"Oktopost's Twitter",
        "DisplayName":"Oktopost",
        "Status":"valid",
        "Network":"Twitter",
        "ImageLink":"valid",
        "NetworkUsername":"oktopost",
        "NativePostsEnabled":0
    }
}

List Social Profiles

Example Request

curl -i https://api.oktopost.com/v2/credential?network=Twitter?includeInvalid=0

Parameters

Results can be filtered by network. Acceptable values are: LinkedIn, Twitter, Youtube, Instagram and Facebook.

ParamDefaultOptionalDescription
network-Acceptable values are: LinkedIn, Twitter, Youtube, Instagram and Facebook.
includeInvalid0If set to 1, the response will include invalid credentials.

Example Result

{
"Result":true,
    "Items":[{
        "Id":"003-001000000000000-10795428XXXXXXXXX",
        "Created":"2015-10-26 21:02:30",
        "Name":"Oktopost's Twitter",
        "DisplayName":"Oktopost",
        "Status":"valid",
        "Network":"Twitter",
        "ImageLink":"valid",
        "NetworkUsername":"oktopost",
        "NativePostsEnabled":0
    },
    ...
    ],
    "Total":21
}

Update a Social Profile

Update a single social profile by Id.

Example Request

curl -i https://api.oktopost.com/v2/credential/003-001000000000000-10795428XXXXXXXXX -X PUT \
-d displayName="Oktopost Twitter" \
-d nativePostsEnabled=1

Example Response

{
    "Result": true,
    "Credential": {...}
}

Delete a Social Profile

Deleting a profile will delete all scheduled posts using it.

Example Request

curl -i https://api.oktopost.com/v2/credential/003-001000000000000-10795428XXXXXXXXX -X DELETE