Skip to main content
GET
/
profiles
curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://api.ayrshare.com/api/profiles

{
    "profiles": [
        {
            "status": "active",
            "title": "Digg It Title",
            "displayTitle": "Your title",
            "created": {
                "_seconds": 1604094099,
                "_nanoseconds": 530000000
            },
            "createdUTC": "2022-03-02T16:11:00.839Z",
            "refId": "160c8700bd6ade099b242d845e268fb986130c53",
            "activeSocialAccounts": [
                "twitter",
                "facebook",
                "linkedin",
                "instagram"
            ],
            "isByokLinked": true
        },
        {
            "status": "active",
            "title": "Super Profile",
            "created": {
                "_seconds": 1604377627,
                "_nanoseconds": 252000000
            },
            "createdUTC": "2022-03-02T16:11:00.839Z",
            "refId": "170a8700bd6ade099b242d845e268fb986130c53"
        },
        {
            "status": "suspended",
            "title": "Good Fun Title",
            "created": {
                "_seconds": 1605107864,
                "_nanoseconds": 96000000
            },
            "createdUTC": "2022-03-02T16:11:00.839Z",
            "refId": "180s8700bd6ade099b242d845e268fb986130c53",
            "activeSocialAccounts": [
                "facebook",
                "linkedin",
                "youtube"
            ],
            "suspended": true
        }
    ],
    "count": 100,
    "lastUpdated": "2025-06-14T15:53:26.016Z",
    "nextUpdate": "2025-06-14T15:58:26.016Z",
    "pagination": {
        "hasMore": true,
        "nextCursor": "eyJjcmVhdGVkIjoiMjAyNS0wNi0xNFQwMjo1",
        "limit": 100
    }
}
Get all the profiles associated with the primary profile. The Primary Profile is not returned in the results. For security, the Profile Keys are not returned via this GET call. Please see here for more information.

​
Header Parameters

​
Query Parameters

​
title
string
Return only the profile associated with the URL encoded title.
​
refId
string
Return only the profile associated with the given refId. The refId was returned during the profile creation or from the /user endpoint.
​
hasActiveSocialAccounts
boolean
default:false
If true return only profiles that have at least one connected social account (activeSocialAccounts length greater than zero). If false return only profiles with zero connected social accounts (activeSocialAccounts length is zero).
​
includesActiveSocialAccounts
array
Filter profiles to include those whose activeSocialAccounts contain all of the social media platforms specified in the includesActiveSocialAccounts list. Profiles can have additional platforms in their activeSocialAccounts beyond those listed in includesActiveSocialAccounts and still be included in the filtered results.Values: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, youtube.
​
isByokLinked
boolean
Filter profiles by BYOK (Bring Your Own Key) migration status. If true, return only profiles that have completed BYOK migration. If false, return only profiles that have a BYOK-eligible platform connected but have not yet migrated. Profiles without a BYOK-eligible platform are excluded when this filter is set. When omitted, all profiles are returned regardless of BYOK status. Currently applies to X/Twitter BYOK.
​
actionLog
boolean
default:false
Return the User Profile create and delete action log history for the past 60 days and the active user count used for billing for the past 60 days. Note:
  • Action Log: Title and tags will not be returned for action log history prior to March 2025.
  • User Profile Report: The time period might not correspond to your billing period. For example, your billing period might start and end on the 10th of the month. Please see your invoices for the billing period and other details.
You may specify a different time period by setting the actionLog to a number of days. For example, actionLog=10 query parameter will return the action log for the past 10 days and the reported active user count for the past 10 days. The time period allowed is 1 day to 365 days.
​
limit
number
default:5000
Limit the number of profiles returned. The default and maximum is 5000.
​
cursor
string
If there are additional profiles to return and the hasMore flag is true, the nextCursor will be returned in the response. Pass this cursor to the cursor query parameter to return the next set of profiles.
​
include
string | array
Return extended profile data for troubleshooting. Requires refId parameter (single profile lookup).Values (comma-separated string or array): suspension, socialHealth, linkingErrors, activity, quota, unlinkHistory, actionLog.
  • suspension - isSuspended, reason, suspendedAt, unsuspendAt, suspensionCount
  • socialHealth - Per-platform: linked, linkedAt, relinkRecommended, messagingEnabled, tokenExpiresAt
  • linkingErrors - Per-platform: code, message, details, createdAt
  • activity - lastApiCall, lastPost timestamps
  • quota - used, limit
  • unlinkHistory - Last unlink: platform, source (user/system), details, createdAt
  • actionLog - Profile action history (create/update/delete)
curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://api.ayrshare.com/api/profiles

{
    "profiles": [
        {
            "status": "active",
            "title": "Digg It Title",
            "displayTitle": "Your title",
            "created": {
                "_seconds": 1604094099,
                "_nanoseconds": 530000000
            },
            "createdUTC": "2022-03-02T16:11:00.839Z",
            "refId": "160c8700bd6ade099b242d845e268fb986130c53",
            "activeSocialAccounts": [
                "twitter",
                "facebook",
                "linkedin",
                "instagram"
            ],
            "isByokLinked": true
        },
        {
            "status": "active",
            "title": "Super Profile",
            "created": {
                "_seconds": 1604377627,
                "_nanoseconds": 252000000
            },
            "createdUTC": "2022-03-02T16:11:00.839Z",
            "refId": "170a8700bd6ade099b242d845e268fb986130c53"
        },
        {
            "status": "suspended",
            "title": "Good Fun Title",
            "created": {
                "_seconds": 1605107864,
                "_nanoseconds": 96000000
            },
            "createdUTC": "2022-03-02T16:11:00.839Z",
            "refId": "180s8700bd6ade099b242d845e268fb986130c53",
            "activeSocialAccounts": [
                "facebook",
                "linkedin",
                "youtube"
            ],
            "suspended": true
        }
    ],
    "count": 100,
    "lastUpdated": "2025-06-14T15:53:26.016Z",
    "nextUpdate": "2025-06-14T15:58:26.016Z",
    "pagination": {
        "hasMore": true,
        "nextCursor": "eyJjcmVhdGVkIjoiMjAyNS0wNi0xNFQwMjo1",
        "limit": 100
    }
}