User
User Profile Details
Get Started
API Endpoints
- Ayrshare API Overview
- Ads
- Analytics
- Auto Schedule
- Brand
- Comments
- Feed
- Generate
- Hashtags
- History
- Links
- Media
- Messages
- Post
- Profiles
- Reviews
- User
- Utils
- Validate
- Webhooks
Multiple Users
Dashboard
- Overview
- Connect Social Accounts
- Publish a Post
- Revoke Access to Social Media
- RSS
Additional
- What's New At Ayrshare
- Errors
- Max Pack
- Media Guidelines
- Packages & Guides
- System Status
- Testing & Verification
- ISO Codes
User
User Profile Details
Get information on the user or user profile including linked social networks and social usernames
GET
/
user
curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://api.ayrshare.com/api/user
{
"activeSocialAccounts": [
"bluesky",
"facebook",
"gmb",
"instagram",
"linkedin",
"pinterest",
"reddit",
"telegram",
"tiktok",
"twitter",
"youtube"
],
"ayrlinkUrl": "https://ayrl.ink/bio/ayrshare", // Ayrlink Bio Page URL
"created": {
"_seconds": 1667351022,
"_nanoseconds": 814000000,
"utc": "2022-11-02T01:03:42Z"
},
"displayNames": [
{
"created": "2025-01-06T21:30:19.756Z",
"description": "Ayrshare's Social APIs provide the core infrastructure for social media posting, management, and analytics.",
"displayName": "Ayrshare",
"id": "did:plc:62musrcyanhro2lydyhl", // Bluesky Id
"platform": "bluesky",
"userImage": "https://cdn.bsky.app/img/avatar/plain/did:plc:62musrcyanhro2lydyhlw7ci/bafkreie",
"username": "ayrshare.com"
},
{
"created": "2022-11-14T16:18:49.110Z",
"displayName": "Ayrshare",
"id": "106638152329", // Facebook Page Id
"messagingActive": true, // Messaging active for the social network
"pageName": "Ayrshare",
"platform": "facebook",
"profileUrl": "https://www.facebook.com/ayrshare",
"userId": "283748192833", // Facebook User Id
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/facebook.jpeg" // The image at the time of linking
},
{
"created": "2024-03-27T20:47:46.251Z",
"description": "Easy to integrate Social Media APIs allow you to manage all your users' social accounts right from your product. Post, Auto Schedule, and Analytics. Great for SaaS, CMS, DAM, Agencies, and Apps.",
"displayName": "Ayrshare",
"mapsUrl": "https://maps.google.com/maps?cid=5229466225881728772",
"placeId": "ChIJN53jw8BZwokRBEeVVtPLkkg",
"platform": "gmb",
"profileUrl": "https://www.ayrshare.com/",
"reviewUrl": "https://search.google.com/local/writereview?placeid=ChIJN53jw8BZwokRBEeVVtPLkkg"
},
{
"created": "2022-11-09T20:36:58.659Z",
"displayName": "Ayrshare",
"id": "1784144322", // Associate Facebook Page Id
"messagingActive": true, // Messaging active for the social network
"pageName": "Social Media API",
"platform": "instagram",
"profileUrl": "https://www.instagram.com/ayrshare",
"type": "business", // "business" returned for both business and creator account types. Only returned if instagramQuota: true
"usedQuota": 34, // Instagram quota. 50 posts per rolling 24-hour period. Returned if instagramQuota: true
"userId": "2938492293422", // Instagram User Id
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/instagram.jpeg", // The image at the time of linking
"username": "ayrshare",
// Additional Instagram details with instagramDetails=true
"type": "business", // business or creator
"usedQuota": 20 // daily quota used - Instagram allows 50 posts per rolling 24-hour period
},
{
"created": "2022-11-17T18:52:29.830Z",
"displayName": "Ayrshare",
"id": "72157",
"platform": "linkedin",
"profileUrl": "https://www.linkedin.com/company/ayrshare",
"refreshDaysRemaining": 364, // Days until link auth must be refreshed
"refreshRequired": "2023-11-17T18:52:29.830Z",
"type": "corporate", // corporate or personal
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/linkedin.jpeg", // The image at the time of linking
"username": "ayrshare" // logged in username
},
{
"created": "2022-12-06T03:16:52.642Z",
"displayName": "Ayrshare",
"id": "42995790741",
"platform": "pinterest",
"profileUrl": "https://www.pinterest.com/ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/pinterest.jpeg", // The image at the time of linking
"username": "ayrshare"
},
{
"created": "2022-11-17T18:55:34.419Z",
"displayName": "funone",
"platform": "reddit",
"profileUrl": "https://www.reddit.com/user/funone",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/reddit.png", // The image at the time of linking
"username": "funone"
},
{
"created": "2022-11-17T18:55:16.320Z",
"displayName": "Ayrshare",
"id": -10017122,
"platform": "telegram",
"profileUrl": "https://web.telegram.org/z/#-17122",
"type": "channel",
"userImage": "https://img.ayrshare.com/nclMLxaIzmXHxOi4KEggA5gQ1T82/social/telegram.octo-stream" // The image at the time of linking
},
{
"created": "2022-11-02T02:11:53.452Z",
"displayName": "Ayrshare",
"id": "5ebc6f39-7900-421e-bf9",
"platform": "tiktok",
"profileUrl": "https://www.tiktok.com/@ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/tiktok.jpeg", // The image at the time of linking
"username": "@ayrshare"
},
{
"created": "2022-11-02T01:38:42.326Z",
"displayName": "ayrshare",
"id": "1194881472",
"messagingActive": true,
"platform": "twitter", // Messaging active for the social network
"profileUrl": "https://twitter.com/ayrshare",
"subscriptionType": "Premium", // Premium, PremiumPlus, None
"twitterUsage": { // Available for Primary Profile. .../ayrshare.com/rest-api/errors/errors-http#id-429-rate-limit
"monthlyUsage": 4323,
"monthlyLimit": 100000,
"monthlyReset": "2024-02-02"
},
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/twitter.png", // The image at the time of linking
"username": "ayrshare",
"verifiedType": "blue" // Values "blue", "business", or "none". Both "blue" and "business" are considered Premium. This will be updated when an X post is done via Ayrshare.
},
{
"created": "2022-11-17T18:54:09.954Z",
"displayName": "@ayrshare",
"id": "106891058521430758565",
"platform": "youtube",
"profileUrl": "https://www.youtube.com/@ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/youtube.png", // The image at the time of linking
"username": "@ayrshare"
}
],
"email": "[email protected]", // null if a User Profile
"lastApiCall": "2024-08-14T15:18:11Z", // Time of the last recorded API call for this user
"messagingConversationMonthlyCount": 7, // Monthly conversation count out of 100 - contact us if you need more per user profile
"messagingEnabled": true, // Messaging enabled for the account
"monthlyApiCalls": 49, // Current number of Posts, but starting Feb 1, 2025, this will include all types of API calls
"monthlyPostCount": 49, // Count of monthly posts
"monthlyPostQuota": 500, // Quota of monthly API post calls. Not present for Business Plans.
"monthlyApiCallsQuota": 500, // Deprecated Feb 1, 2025. Use monthlyPostQuota instead.
"refId": "13a9da9e0df1183a7a6a1fc2c60b8023fa9a32a0", // User Profile reference ID
"title": "Primary Profile", // User Profile Title - Business Plan only
"lastUpdated": "2024-01-04T15:51:17.775Z",
"nextUpdate": "2024-01-04T15:51:47.775Z"
}
Available on Basic, Premium, Business, Enterprise plans.
If no social accounts are linked, activeSocialAccounts
will not be returned.
Get data for a particular User Profile by adding the Profile-Key in the header.
- If your business requires gathering all of your user profile data at once, please use the /user/batch endpoint.
- If you need a notification when a user links and unlinks a social account, please see the /webhooks endpoint.
Header Parameters
Query Parameters
Returns additional Instagram details such as account type (business or creator) and used quota. Not recommended unless you need the additional data since it will slow down the response time.
curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://api.ayrshare.com/api/user
{
"activeSocialAccounts": [
"bluesky",
"facebook",
"gmb",
"instagram",
"linkedin",
"pinterest",
"reddit",
"telegram",
"tiktok",
"twitter",
"youtube"
],
"ayrlinkUrl": "https://ayrl.ink/bio/ayrshare", // Ayrlink Bio Page URL
"created": {
"_seconds": 1667351022,
"_nanoseconds": 814000000,
"utc": "2022-11-02T01:03:42Z"
},
"displayNames": [
{
"created": "2025-01-06T21:30:19.756Z",
"description": "Ayrshare's Social APIs provide the core infrastructure for social media posting, management, and analytics.",
"displayName": "Ayrshare",
"id": "did:plc:62musrcyanhro2lydyhl", // Bluesky Id
"platform": "bluesky",
"userImage": "https://cdn.bsky.app/img/avatar/plain/did:plc:62musrcyanhro2lydyhlw7ci/bafkreie",
"username": "ayrshare.com"
},
{
"created": "2022-11-14T16:18:49.110Z",
"displayName": "Ayrshare",
"id": "106638152329", // Facebook Page Id
"messagingActive": true, // Messaging active for the social network
"pageName": "Ayrshare",
"platform": "facebook",
"profileUrl": "https://www.facebook.com/ayrshare",
"userId": "283748192833", // Facebook User Id
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/facebook.jpeg" // The image at the time of linking
},
{
"created": "2024-03-27T20:47:46.251Z",
"description": "Easy to integrate Social Media APIs allow you to manage all your users' social accounts right from your product. Post, Auto Schedule, and Analytics. Great for SaaS, CMS, DAM, Agencies, and Apps.",
"displayName": "Ayrshare",
"mapsUrl": "https://maps.google.com/maps?cid=5229466225881728772",
"placeId": "ChIJN53jw8BZwokRBEeVVtPLkkg",
"platform": "gmb",
"profileUrl": "https://www.ayrshare.com/",
"reviewUrl": "https://search.google.com/local/writereview?placeid=ChIJN53jw8BZwokRBEeVVtPLkkg"
},
{
"created": "2022-11-09T20:36:58.659Z",
"displayName": "Ayrshare",
"id": "1784144322", // Associate Facebook Page Id
"messagingActive": true, // Messaging active for the social network
"pageName": "Social Media API",
"platform": "instagram",
"profileUrl": "https://www.instagram.com/ayrshare",
"type": "business", // "business" returned for both business and creator account types. Only returned if instagramQuota: true
"usedQuota": 34, // Instagram quota. 50 posts per rolling 24-hour period. Returned if instagramQuota: true
"userId": "2938492293422", // Instagram User Id
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/instagram.jpeg", // The image at the time of linking
"username": "ayrshare",
// Additional Instagram details with instagramDetails=true
"type": "business", // business or creator
"usedQuota": 20 // daily quota used - Instagram allows 50 posts per rolling 24-hour period
},
{
"created": "2022-11-17T18:52:29.830Z",
"displayName": "Ayrshare",
"id": "72157",
"platform": "linkedin",
"profileUrl": "https://www.linkedin.com/company/ayrshare",
"refreshDaysRemaining": 364, // Days until link auth must be refreshed
"refreshRequired": "2023-11-17T18:52:29.830Z",
"type": "corporate", // corporate or personal
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/linkedin.jpeg", // The image at the time of linking
"username": "ayrshare" // logged in username
},
{
"created": "2022-12-06T03:16:52.642Z",
"displayName": "Ayrshare",
"id": "42995790741",
"platform": "pinterest",
"profileUrl": "https://www.pinterest.com/ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/pinterest.jpeg", // The image at the time of linking
"username": "ayrshare"
},
{
"created": "2022-11-17T18:55:34.419Z",
"displayName": "funone",
"platform": "reddit",
"profileUrl": "https://www.reddit.com/user/funone",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/reddit.png", // The image at the time of linking
"username": "funone"
},
{
"created": "2022-11-17T18:55:16.320Z",
"displayName": "Ayrshare",
"id": -10017122,
"platform": "telegram",
"profileUrl": "https://web.telegram.org/z/#-17122",
"type": "channel",
"userImage": "https://img.ayrshare.com/nclMLxaIzmXHxOi4KEggA5gQ1T82/social/telegram.octo-stream" // The image at the time of linking
},
{
"created": "2022-11-02T02:11:53.452Z",
"displayName": "Ayrshare",
"id": "5ebc6f39-7900-421e-bf9",
"platform": "tiktok",
"profileUrl": "https://www.tiktok.com/@ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/tiktok.jpeg", // The image at the time of linking
"username": "@ayrshare"
},
{
"created": "2022-11-02T01:38:42.326Z",
"displayName": "ayrshare",
"id": "1194881472",
"messagingActive": true,
"platform": "twitter", // Messaging active for the social network
"profileUrl": "https://twitter.com/ayrshare",
"subscriptionType": "Premium", // Premium, PremiumPlus, None
"twitterUsage": { // Available for Primary Profile. .../ayrshare.com/rest-api/errors/errors-http#id-429-rate-limit
"monthlyUsage": 4323,
"monthlyLimit": 100000,
"monthlyReset": "2024-02-02"
},
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/twitter.png", // The image at the time of linking
"username": "ayrshare",
"verifiedType": "blue" // Values "blue", "business", or "none". Both "blue" and "business" are considered Premium. This will be updated when an X post is done via Ayrshare.
},
{
"created": "2022-11-17T18:54:09.954Z",
"displayName": "@ayrshare",
"id": "106891058521430758565",
"platform": "youtube",
"profileUrl": "https://www.youtube.com/@ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/youtube.png", // The image at the time of linking
"username": "@ayrshare"
}
],
"email": "[email protected]", // null if a User Profile
"lastApiCall": "2024-08-14T15:18:11Z", // Time of the last recorded API call for this user
"messagingConversationMonthlyCount": 7, // Monthly conversation count out of 100 - contact us if you need more per user profile
"messagingEnabled": true, // Messaging enabled for the account
"monthlyApiCalls": 49, // Current number of Posts, but starting Feb 1, 2025, this will include all types of API calls
"monthlyPostCount": 49, // Count of monthly posts
"monthlyPostQuota": 500, // Quota of monthly API post calls. Not present for Business Plans.
"monthlyApiCallsQuota": 500, // Deprecated Feb 1, 2025. Use monthlyPostQuota instead.
"refId": "13a9da9e0df1183a7a6a1fc2c60b8023fa9a32a0", // User Profile reference ID
"title": "Primary Profile", // User Profile Title - Business Plan only
"lastUpdated": "2024-01-04T15:51:17.775Z",
"nextUpdate": "2024-01-04T15:51:47.775Z"
}
curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://api.ayrshare.com/api/user
{
"activeSocialAccounts": [
"bluesky",
"facebook",
"gmb",
"instagram",
"linkedin",
"pinterest",
"reddit",
"telegram",
"tiktok",
"twitter",
"youtube"
],
"ayrlinkUrl": "https://ayrl.ink/bio/ayrshare", // Ayrlink Bio Page URL
"created": {
"_seconds": 1667351022,
"_nanoseconds": 814000000,
"utc": "2022-11-02T01:03:42Z"
},
"displayNames": [
{
"created": "2025-01-06T21:30:19.756Z",
"description": "Ayrshare's Social APIs provide the core infrastructure for social media posting, management, and analytics.",
"displayName": "Ayrshare",
"id": "did:plc:62musrcyanhro2lydyhl", // Bluesky Id
"platform": "bluesky",
"userImage": "https://cdn.bsky.app/img/avatar/plain/did:plc:62musrcyanhro2lydyhlw7ci/bafkreie",
"username": "ayrshare.com"
},
{
"created": "2022-11-14T16:18:49.110Z",
"displayName": "Ayrshare",
"id": "106638152329", // Facebook Page Id
"messagingActive": true, // Messaging active for the social network
"pageName": "Ayrshare",
"platform": "facebook",
"profileUrl": "https://www.facebook.com/ayrshare",
"userId": "283748192833", // Facebook User Id
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/facebook.jpeg" // The image at the time of linking
},
{
"created": "2024-03-27T20:47:46.251Z",
"description": "Easy to integrate Social Media APIs allow you to manage all your users' social accounts right from your product. Post, Auto Schedule, and Analytics. Great for SaaS, CMS, DAM, Agencies, and Apps.",
"displayName": "Ayrshare",
"mapsUrl": "https://maps.google.com/maps?cid=5229466225881728772",
"placeId": "ChIJN53jw8BZwokRBEeVVtPLkkg",
"platform": "gmb",
"profileUrl": "https://www.ayrshare.com/",
"reviewUrl": "https://search.google.com/local/writereview?placeid=ChIJN53jw8BZwokRBEeVVtPLkkg"
},
{
"created": "2022-11-09T20:36:58.659Z",
"displayName": "Ayrshare",
"id": "1784144322", // Associate Facebook Page Id
"messagingActive": true, // Messaging active for the social network
"pageName": "Social Media API",
"platform": "instagram",
"profileUrl": "https://www.instagram.com/ayrshare",
"type": "business", // "business" returned for both business and creator account types. Only returned if instagramQuota: true
"usedQuota": 34, // Instagram quota. 50 posts per rolling 24-hour period. Returned if instagramQuota: true
"userId": "2938492293422", // Instagram User Id
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/instagram.jpeg", // The image at the time of linking
"username": "ayrshare",
// Additional Instagram details with instagramDetails=true
"type": "business", // business or creator
"usedQuota": 20 // daily quota used - Instagram allows 50 posts per rolling 24-hour period
},
{
"created": "2022-11-17T18:52:29.830Z",
"displayName": "Ayrshare",
"id": "72157",
"platform": "linkedin",
"profileUrl": "https://www.linkedin.com/company/ayrshare",
"refreshDaysRemaining": 364, // Days until link auth must be refreshed
"refreshRequired": "2023-11-17T18:52:29.830Z",
"type": "corporate", // corporate or personal
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/linkedin.jpeg", // The image at the time of linking
"username": "ayrshare" // logged in username
},
{
"created": "2022-12-06T03:16:52.642Z",
"displayName": "Ayrshare",
"id": "42995790741",
"platform": "pinterest",
"profileUrl": "https://www.pinterest.com/ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/pinterest.jpeg", // The image at the time of linking
"username": "ayrshare"
},
{
"created": "2022-11-17T18:55:34.419Z",
"displayName": "funone",
"platform": "reddit",
"profileUrl": "https://www.reddit.com/user/funone",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/reddit.png", // The image at the time of linking
"username": "funone"
},
{
"created": "2022-11-17T18:55:16.320Z",
"displayName": "Ayrshare",
"id": -10017122,
"platform": "telegram",
"profileUrl": "https://web.telegram.org/z/#-17122",
"type": "channel",
"userImage": "https://img.ayrshare.com/nclMLxaIzmXHxOi4KEggA5gQ1T82/social/telegram.octo-stream" // The image at the time of linking
},
{
"created": "2022-11-02T02:11:53.452Z",
"displayName": "Ayrshare",
"id": "5ebc6f39-7900-421e-bf9",
"platform": "tiktok",
"profileUrl": "https://www.tiktok.com/@ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/tiktok.jpeg", // The image at the time of linking
"username": "@ayrshare"
},
{
"created": "2022-11-02T01:38:42.326Z",
"displayName": "ayrshare",
"id": "1194881472",
"messagingActive": true,
"platform": "twitter", // Messaging active for the social network
"profileUrl": "https://twitter.com/ayrshare",
"subscriptionType": "Premium", // Premium, PremiumPlus, None
"twitterUsage": { // Available for Primary Profile. .../ayrshare.com/rest-api/errors/errors-http#id-429-rate-limit
"monthlyUsage": 4323,
"monthlyLimit": 100000,
"monthlyReset": "2024-02-02"
},
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/twitter.png", // The image at the time of linking
"username": "ayrshare",
"verifiedType": "blue" // Values "blue", "business", or "none". Both "blue" and "business" are considered Premium. This will be updated when an X post is done via Ayrshare.
},
{
"created": "2022-11-17T18:54:09.954Z",
"displayName": "@ayrshare",
"id": "106891058521430758565",
"platform": "youtube",
"profileUrl": "https://www.youtube.com/@ayrshare",
"userImage": "https://img.ayrshare.com/ndfdfJ239s/social/youtube.png", // The image at the time of linking
"username": "@ayrshare"
}
],
"email": "[email protected]", // null if a User Profile
"lastApiCall": "2024-08-14T15:18:11Z", // Time of the last recorded API call for this user
"messagingConversationMonthlyCount": 7, // Monthly conversation count out of 100 - contact us if you need more per user profile
"messagingEnabled": true, // Messaging enabled for the account
"monthlyApiCalls": 49, // Current number of Posts, but starting Feb 1, 2025, this will include all types of API calls
"monthlyPostCount": 49, // Count of monthly posts
"monthlyPostQuota": 500, // Quota of monthly API post calls. Not present for Business Plans.
"monthlyApiCallsQuota": 500, // Deprecated Feb 1, 2025. Use monthlyPostQuota instead.
"refId": "13a9da9e0df1183a7a6a1fc2c60b8023fa9a32a0", // User Profile reference ID
"title": "Primary Profile", // User Profile Title - Business Plan only
"lastUpdated": "2024-01-04T15:51:17.775Z",
"nextUpdate": "2024-01-04T15:51:47.775Z"
}