user

User API Endpoint: Get details on a user's social media account including linked social networks and social usernames.

User API Endpoint

❗Click the › in the endpoint to view details.

Get user profile details

GET https://app.ayrshare.com/api/user

Get information on the user or user profile including linked social networks and social usernames.

Query Parameters

Name	Type	Description
instagramQuota	boolean	Return the current Instagram quota used - 50 posts over a 24-hour rolling period and the Instagram profile type: creator or business. Default: false.
validate	boolean	Check if a user profile still exists. If the user profile no longer exists, the delete details will be returned. Must include the Profile Key in the header. Optional.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API_KEY. See Overview for more information.
Profile-Key	string	The Profile Key of a user profile.

200 User data returned. Display Names are the user assigned account names at the social networks. If display name not present will return empty string.

{
    "activeSocialAccounts": [
        "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": "2022-11-14T16:18:49.110Z",
            "displayName": "Ayrshare",
            "id": "106638152329",
            "pageName": "Ayrshare",
            "platform": "facebook",
            "profileUrl": "https://www.facebook.com/ayrshare",
            "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",
            "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
            "userImage": "https://img.ayrshare.com/ndfdfJ239s/social/instagram.jpeg", // The image at the time of linking
            "username": "ayrshare"
        },
        {
            "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",
            "platform": "twitter",
            "profileUrl": "https://twitter.com/ayrshare",
            "twitterUsage": { // Available for Primary Profile. https://docs.ayrshare.com/rest-api/errors/http-status-codes#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"
        },
        {
            "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": "[e-mail]",    // null if a User Profile
    "monthlyApiCalls": 49,         // Count of monthly API post calls
    "monthlyApiCallsQuota": 500,   // Quota of monthly API post calls. Not present for Business Plans.
    "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"
}

403: Forbidden Profile Key not found

{
    "action": "post",
    "status": "error",
    "code": 144,
    "message": "Some profiles not found. Please verify the Profile Keys."
}

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.

Request Examples

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://app.ayrshare.com/api/user

Node.js

const API_KEY = "API_KEY";

fetch("https://app.ayrshare.com/api/user", {
      method: "GET",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      }
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

Python

import requests

headers = {'Authorization': 'Bearer API_KEY'}
r = requests.get('https://app.ayrshare.com/api/user', headers=headers)
    
print(r.json())

PHP

<?php

$apiUrl = 'https://app.ayrshare.com/api/user';
$apiKey = 'API_KEY';  // Replace 'API_KEY' with your actual API key

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey,
];

$curl = curl_init($apiUrl);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers
]);

$response = curl_exec($curl);

if ($response === false) {
    echo 'Curl error: ' . curl_error($curl);
} else {
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
}

curl_close($curl);

C#

using System;
using System.Net;
using System.IO;

namespace UserGETRequest_charp
{
    class User
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/user";

            var httpWebRequest = WebRequest.CreateHttp(url);
            httpWebRequest.ContentType = "application/json";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}

---

Get Pinterest user board details

GET https://app.ayrshare.com/api/user/details/:platform

Get the details of a particular platform. Current support for Pinterest Boards.

Currently supported platform values: "pinterest"

https://app.ayrshare.com/api/user/details/pinterest

Premium, Business, or Enterprise Plan required.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API_KEY. See Overview for more information.
Profile-Key	string	The Profile Key of a user profile.

200: OK Pinterest Boards returned

{
    "pinterest": [
        {
            "privacy": "PUBLIC",
            "owner": {
                "username": "ayrshare"
            },
            "id": "718465015493014420",
            "name": "Coworking",
            "description": ""
        },
        {
            "privacy": "PUBLIC",
            "owner": {
                "username": "ayrshare"
            },
            "id": "718465015493634450",
            "name": "Social Media Networks",
            "description": ""
        }
    ]
}

Request Examples

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://app.ayrshare.com/api/user/details/pinterest

Node.js

const API_KEY = "API_KEY";

fetch("https://app.ayrshare.com/api/user/details/pinterest", {
      method: "GET",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      }
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

Python

import requests

headers = {'Authorization': 'Bearer API_KEY'}

r = requests.get('https://app.ayrshare.com/api/user/details/pinterest', headers=headers)
    
print(r.json())

PHP

<?php

$apiUrl = 'https://app.ayrshare.com/api/user/details/pinterest';
$apiKey = 'API_KEY';  // Replace 'API_KEY' with your actual API key

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey,
];

$curl = curl_init($apiUrl);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers
]);

$response = curl_exec($curl);

if ($response === false) {
    echo 'Curl error: ' . curl_error($curl);
} else {
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
}

curl_close($curl);

C#

using System;
using System.Net;
using System.IO;

namespace UserGETRequest_charp
{
    class User
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/user/details/pinterest";

            var httpWebRequest = WebRequest.CreateHttp(url);
            httpWebRequest.ContentType = "application/json";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}C#

---

Batch Get All User Profiles

GET https://app.ayrshare.com/api/user/batch

Retrieve the user data for all user profiles. Use the batch endpoint as an alternative to calling the /user endpoint for each of your users in rapid succession, which maybe be restricted by rate-limits.

The endpoint will return a pre-signed URL for the file containing all the user profile data. Please note the urlAvailable field time for when the file will be accessible.

The pre-signed URL will expire in 7 days after creation. A new file may be generated every 3 hours.

You may also be notified when the file is ready via the Batch Action webhook.

Headers

Name	Type	Description
Authorization*	string	Format: Authorization: Bearer API_KEY. See Overview for more information.

200: OK Successful file creation

{
    "success": true,
    "url": "https://storage.googleapis.com/batch.ayrshare.com/users/9iskiedwtOddd/users-batch-2024-01-11-22-42.json",
    "urlAvailable": "2024-01-11T22:47:36Z",
    "urlExpires": "2024-01-18T22:42:36Z",
    "lastUpdated": "2024-01-11T22:42:36.808Z",
    "nextUpdate": "2024-01-11T22:54:36.808Z"
}

403: Forbidden Failed authorization

{
    "action": "authorization",
    "status": "error",
    "code": 102,
    "message": "API Key not valid. Please be sure to send a Header Authorization containing 'Bearer API_KEY'. https://docs.ayrshare.com/rest-api/overview#authorization"
}

Request Examples

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-X GET https://app.ayrshare.com/api/user/batch

Node.js

const API_KEY = "API_KEY";

fetch("https://app.ayrshare.com/api/user/batch", {
      method: "GET",
      headers: {
        "Authorization": `Bearer ${API_KEY}`
      }
    })
      .then((res) => res.json())
      .then((json) => console.log(json))
      .catch(console.error);

Python

import requests

headers = {'Authorization': 'Bearer API_KEY'}
r = requests.get('https://app.ayrshare.com/api/user/batch', headers=headers)
    
print(r.json())

PHP

<?php

$apiUrl = 'https://app.ayrshare.com/api/user/batch';
$apiKey = 'API_KEY';  // Replace 'API_KEY' with your actual API key

$headers = [
    'Content-Type: application/json',
    'Authorization: Bearer ' . $apiKey,
];

$curl = curl_init($apiUrl);
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => $headers
]);

$response = curl_exec($curl);

if ($response === false) {
    echo 'Curl error: ' . curl_error($curl);
} else {
    echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
}

curl_close($curl);

C#

using System;
using System.Net;
using System.IO;

namespace UserGETRequest_charp
{
    class User
    {
        static void Main(string[] args)
        {
            string API_KEY = "API_KEY";
            string url = "https://app.ayrshare.com/api/user";

            var httpWebRequest = WebRequest.CreateHttp(url);
            httpWebRequest.ContentType = "application/json";
            httpWebRequest.Headers.Add("Authorization", "Bearer " + API_KEY);

            var httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
            using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
            {
                var response = streamReader.ReadToEnd();
                Console.WriteLine(response);
            }
        }
    }
}