> ## 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 を取得する

> プライマリプロファイルに関連付けられたすべてのプロファイルを取得します。

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 Keys はこの GET 呼び出しでは返されません。詳細は [こちら](/apis/profiles/create-profile) を参照してください。

## Header Parameters

<HeaderAPI noProfileKey />

## Query Parameters

<ParamField query="title" type="string">
  URL エンコードされたタイトルに関連付けられたプロファイルのみを返します。
</ParamField>

<ParamField query="refId" type="string">
  指定された `refId` に関連付けられたプロファイルのみを返します。refId は、プロファイル作成時または /user エンドポイントから返されます。
</ParamField>

<ParamField query="hasActiveSocialAccounts" type="boolean" default={false}>
  `true` の場合、接続されたソーシャルアカウントを少なくとも 1 つ持つプロファイルのみを返します（`activeSocialAccounts` の長さが 0 より大きい）。`false` の場合、接続されたソーシャルアカウントが 0 のプロファイルのみを返します（`activeSocialAccounts` の長さが 0）。
</ParamField>

<ParamField query="includesActiveSocialAccounts" type="array">
  `activeSocialAccounts` に `includesActiveSocialAccounts` リストで指定されたソーシャルメディアプラットフォームがすべて含まれるプロファイルにフィルターします。プロファイルの `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）移行ステータスでプロファイルをフィルターします。`true` の場合、BYOK 移行を完了したプロファイルのみを返します。`false` の場合、BYOK 対応プラットフォームが接続されているがまだ移行されていないプロファイルのみを返します。BYOK 対応プラットフォームを持たないプロファイルは、このフィルターが設定されている場合に除外されます。省略された場合、BYOK ステータスに関係なくすべてのプロファイルが返されます。現在は [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>
      アクションログ: タイトルとタグは、2025 年 3 月より前のアクションログ履歴には返されません。
    </li>

    <li>
      User Profile レポート: 期間は請求期間と一致しない場合があります。たとえば、請求期間は月の 10 日に開始および終了する場合があります。
      請求期間およびその他の詳細については、請求書を参照してください。
    </li>
  </ul>

  actionLog に日数を設定することで、異なる期間を指定できます。たとえば、
  `actionLog=10` クエリパラメータは、過去 10 日間のアクションログと過去 10 日間のレポート済みアクティブユーザー数を返します。許可される期間は 1 日から 365 日までです。
</ParamField>

<ParamField query="limit" type="number" default={5000}>
  返されるプロファイルの数を制限します。デフォルトおよび最大は 5000 です。
</ParamField>

<ParamField query="cursor" type="string">
  返す追加のプロファイルがあり、`hasMore` フラグが `true` の場合、レスポンスに `nextCursor` が返されます。
  次のプロファイルのセットを返すには、このカーソルを `cursor` クエリパラメータに渡します。
</ParamField>

<ParamField query="include" type="string | array">
  トラブルシューティング用の拡張プロファイルデータを返します。`refId` パラメータ（単一プロファイル検索）が必要です。

  値（カンマ区切りの文字列または配列）: `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` - プロファイルアクション履歴（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>