> ## Documentation Index
> Fetch the complete documentation index at: https://www.ayrshare.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 取得 User Profiles

> 取得與 Primary Profile 關聯的所有 Profile。

export const PlansAvailable = ({plans = [], maxPackRequired}) => {
  let displayPlans = plans;
  if (plans && plans.length === 1) {
    const lowerCasePlan = plans[0].toLowerCase();
    if (lowerCasePlan === "business") {
      displayPlans = ["Launch", "Business", "Enterprise"];
    } else if (lowerCasePlan === "premium") {
      displayPlans = ["Premium", "Launch", "Business", "Enterprise"];
    }
  }
  return <Note>
Available on {displayPlans.length === 1 ? "the " : ""}
{displayPlans.join(", ").replace(/\b\w/g, l => l.toUpperCase())}{" "}
{displayPlans.length > 1 ? "plans" : "plan"}.

{maxPackRequired && <span onClick={() => window.open('https://www.ayrshare.com/docs/additional/maxpack', '_self')} className="flex items-center mt-2 cursor-pointer">
 <span className="px-1.5 py-0.5 rounded text-sm" style={{
    backgroundColor: '#C264B6',
    color: 'white',
    fontSize: '12px'
  }}>
   Max Pack required
 </span>
</span>}
</Note>;
};

export const HeaderAPI = ({noProfileKey, profileKeyRequired}) => <>
    <ParamField header="Authorization" type="string" required>
      <a href="/apis/overview#authorization">API Key</a> of the Primary Profile.
      <br />
      <br />
      Format: <code>Authorization: Bearer API_KEY</code>
    </ParamField>
    {!noProfileKey && (profileKeyRequired ? <ParamField header="Profile-Key" type="string" required>
          <a href="/apis/overview#profile-key-format">Profile Key</a> of a User Profile.
          <br />
          <br />
          Format: <code>Profile-Key: PROFILE_KEY</code>
        </ParamField> : <ParamField header="Profile-Key" type="string">
          <a href="/apis/overview#profile-key-format">Profile Key</a> of a User Profile.
          <br />
          <br />
          Format: <code>Profile-Key: PROFILE_KEY</code>
        </ParamField>)}
  </>;

<PlansAvailable plans={["business"]} maxPackRequired={false} />

取得與 Primary Profile 關聯的所有 Profile。結果中不會回傳 Primary Profile 本身。

基於安全考量，此 GET 呼叫不會回傳 Profile Key。更多資訊請參閱[這裡](/apis/profiles/create-profile)。

## 標頭參數

<HeaderAPI noProfileKey />

## Query 參數

<ParamField query="title" type="string">
  僅回傳與經 URL 編碼的 title 關聯的 Profile。
</ParamField>

<ParamField query="refId" type="string">
  僅回傳與指定 `refId` 關聯的 Profile。`refId` 是在建立 Profile 時或從 /user 端點回傳的。
</ParamField>

<ParamField query="hasActiveSocialAccounts" type="boolean" default={false}>
  若為 `true`，僅回傳至少已連結一個社群帳號的 Profile（`activeSocialAccounts` 長度大於零）。若為 `false`，僅回傳零個已連結社群帳號的 Profile（`activeSocialAccounts` 長度為零）。
</ParamField>

<ParamField query="includesActiveSocialAccounts" type="array">
  篩選 `activeSocialAccounts` 中包含 `includesActiveSocialAccounts` 清單中所有社群平台的 Profile。Profile 的 `activeSocialAccounts` 可以擁有 `includesActiveSocialAccounts` 以外的其他平台，且仍會被納入篩選結果中。

  值：`bluesky`、`facebook`、`gmb`、`instagram`、`linkedin`、`pinterest`、`reddit`、`snapchat`、`telegram`、`threads`、`tiktok`、`twitter`、`youtube`。
</ParamField>

<ParamField query="isByokLinked" type="boolean">
  依 BYOK（Bring Your Own Key）遷移狀態篩選 Profile。若為 `true`，僅回傳已完成 BYOK 遷移的 Profile。若為 `false`，僅回傳已連結符合 BYOK 資格平台但尚未完成遷移的 Profile。當設定此篩選條件時，未連結任何符合 BYOK 資格平台的 Profile 會被排除。若省略此參數，則不論 BYOK 狀態皆會回傳所有 Profile。目前適用於 [X/Twitter BYOK](/dashboard/connect-social-accounts/x-twitter-byo-keys)。
</ParamField>

<ParamField query="actionLog" type="boolean" default={false}>
  回傳過去 60 天的 User Profile 建立與刪除操作記錄，以及過去 60 天用於計費的活躍使用者數。注意：

  <ul className="custom-bullets">
    <li>
      Action Log：2025 年 3 月之前的操作記錄不會回傳 title 與 tags。
    </li>

    <li>
      User Profile Report：時間範圍不一定與你的計費週期對應。例如你的計費週期可能從每月 10 號開始並在每月 10 號結束。
      計費週期與其他詳情請參閱你的發票。
    </li>
  </ul>

  你可以將 actionLog 設為天數以指定不同的時間範圍。例如，
  `actionLog=10` 查詢參數會回傳過去 10 天的操作記錄與過去 10 天的活躍使用者數。時間範圍允許為 1 天至 365 天。
</ParamField>

<ParamField query="limit" type="number" default={5000}>
  限制回傳的 Profile 數量。預設值與最大值皆為 5000。
</ParamField>

<ParamField query="cursor" type="string">
  若尚有其他 Profile 可回傳（`hasMore` 旗標為 `true`），回應中會回傳 `nextCursor`。
  將此游標傳入 `cursor` 查詢參數即可取得下一批 Profile。
</ParamField>

<ParamField query="include" type="string | array">
  回傳延伸的 Profile 資料以協助疑難排解。需要 `refId` 參數（單一 Profile 查詢）。

  值（以逗號分隔的字串或陣列）：`suspension`、`socialHealth`、`linkingErrors`、`activity`、`quota`、`unlinkHistory`、`actionLog`。

  <ul className="custom-bullets">
    <li>`suspension` - isSuspended、reason、suspendedAt、unsuspendAt、suspensionCount</li>
    <li>`socialHealth` - 各平台：linked、linkedAt、relinkRecommended、messagingEnabled、tokenExpiresAt</li>
    <li>`linkingErrors` - 各平台：code、message、details、createdAt</li>
    <li>`activity` - lastApiCall、lastPost 時間戳</li>
    <li>`quota` - used、limit</li>
    <li>`unlinkHistory` - 最近一次解除連結：platform、source（user/system）、details、createdAt</li>
    <li>`actionLog` - Profile 操作記錄（create/update/delete）</li>
  </ul>
</ParamField>

<RequestExample>
  ```javascript cURL theme={"system"}
  curl \
  -H "Authorization: Bearer API_KEY" \
  -X GET https://api.ayrshare.com/api/profiles
  ```

  ```javascript cURL (with include) theme={"system"}
  curl \
  -H "Authorization: Bearer API_KEY" \
  -X GET "https://api.ayrshare.com/api/profiles?refId=160c8700bd6ade&include=suspension,socialHealth,activity,quota"
  ```

  ```javascript JavaScript theme={"system"}
  const API_KEY = "API_KEY";

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

  ```python Python theme={"system"}
  import requests

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

  r = requests.get('https://api.ayrshare.com/api/profiles', headers=headers)

  print(r.json())
  ```

  ```php PHP theme={"system"}
  <?php

  $url = 'https://api.ayrshare.com/api/profiles';
  $apiKey = 'API_KEY'; // Replace with your actual API key

  $curl = curl_init();

  curl_setopt_array($curl, [
      CURLOPT_URL => $url,
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_HTTPGET => true,
      CURLOPT_HTTPHEADER => [
          'Content-Type: application/json',
          'Authorization: Bearer ' . $apiKey
      ],
  ]);

  $response = curl_exec($curl);

  if (curl_errno($curl)) {
      echo 'Error:' . curl_error($curl);
  } else {
      echo json_encode(json_decode($response), JSON_PRETTY_PRINT);
  }

  curl_close($curl);

  ```

  ```csharp C# theme={"system"}
  using System;
  using System.Net.Http;
  using System.Threading.Tasks;

  namespace ProfilesGETRequest_csharp
  {
  class Profiles
  {
      static async Task Main(string[] args)
      {
          string API_KEY = "API_KEY";
          string url = "https://api.ayrshare.com/api/profiles";

          using (var client = new HttpClient())
          {
              client.DefaultRequestHeaders.Add("Authorization", "Bearer " + API_KEY);

              try
              {
                  HttpResponseMessage response = await client.GetAsync(url);
                  response.EnsureSuccessStatusCode();
                  string responseBody = await response.Content.ReadAsStringAsync();
                  Console.WriteLine(responseBody);
              }
              catch (HttpRequestException e)
              {
                  Console.WriteLine($"Error: {e.Message}");
              }
          }
      }
  }
  }
  ```
</RequestExample>

<ResponseExample>
  ```javascript 200: Success theme={"system"}
  {
      "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
      }
  }
  ```

  ```json 200: Action Log theme={"system"}
  {
    "profiles": {
      "actionLog": [
          {
              "action": "create",
              "refId": "2d83hd839282ehd892d2999912d1dsdgldfkepw",
              "title": "Profile 1",
              "created": "2025-05-29T14:10:33.709Z"
          },
          {
              "action": "create",
              "refId": "fmm02nd9c3nm9djjffdfsfshfihvp848jcsf222s",
              "title": "Profile 2",
              "created": "2025-05-28T20:33:32.186Z"
          }
      ],
      "userProfilesReport": [
              {
                  "reported": "2025-03-31T08:00:22.651Z",
                  "userProfileCount": 135
              },
              {
                  "reported": "2025-04-01T08:00:16.632Z",
                  "userProfileCount": 135
              }
      ],
      "lastUpdated": "2025-06-14T15:56:02.260Z",
      "nextUpdate": "2025-06-14T16:01:02.260Z"
  }
  ```

  ```json 200: Include Extended Data theme={"system"}
  {
      "profiles": [
          {
              "title": "Brand Marketing",
              "refId": "160c8700bd6ade099b242d845e268fb986130c53",
              "status": "suspended",
              "activeSocialAccounts": ["twitter", "instagram"],
              "suspension": {
                  "isSuspended": true,
                  "reason": "Too many duplicate posts",
                  "suspendedAt": "2026-03-01T10:00:00.000Z",
                  "unsuspendAt": "2026-03-03T10:00:00.000Z",
                  "suspensionCount": 2
              },
              "socialHealth": {
                  "twitter": {
                      "linked": true,
                      "linkedAt": "2026-01-15T10:30:00.000Z",
                      "relinkRecommended": false,
                      "messagingEnabled": true,
                      "tokenExpiresAt": null
                  },
                  "instagram": {
                      "linked": true,
                      "linkedAt": "2026-02-01T08:00:00.000Z",
                      "relinkRecommended": true,
                      "messagingEnabled": false,
                      "tokenExpiresAt": "2026-04-01T08:00:00.000Z"
                  }
              },
              "activity": {
                  "lastApiCall": "2026-03-05T09:15:00.000Z",
                  "lastPost": "2026-03-04T14:30:00.000Z"
              },
              "quota": {
                  "used": 450,
                  "limit": 1000
              }
          }
      ],
      "count": 1,
      "pagination": {
          "hasMore": false,
          "nextCursor": null,
          "limit": 5000
      }
  }
  ```
</ResponseExample>