Linktree API: ディレクトリ — カテゴリー別のユーザー

Q: この Linktree API メソッドはどのようなデータを返しますか？

このメソッドは ディレクトリ に対して「カテゴリー別のユーザー」を実行します。以下のコンパクトなレスポンス例で、フィールドの正確な構造を確認できます。

このエンドポイントの機能

この API メソッドで構築できるもの

まず結果と一般的なワークフローを確認し、次にパラメーターと動作するリクエスト例に進んでください。

このエンドポイントが役立つこと

レスポンスには、ディレクトリの公開データと、次の API リクエストに必要なコンテキストが含まれます。

使用に適した場面

識別子または入力パラメーターがわかっていて、1 つの予測可能な API 結果が必要な場合にこのメソッドを使用します。

主なユースケース

ターゲットを絞った取得

より大きなコレクションを読み込むことなく、必要なオブジェクトだけを要求します。

製品のエンリッチメント

レコード、ワークフロー、社内ツールを Linktree API の結果で補完します。

リクエストのオーケストレーション

レスポンスを関連するメソッドや複数ステップのワークフローの入力として使用します。

利用できるバージョン

レスポンスのバージョン

どちらのバージョンも同じタスクを解決し、同じパラメーターを受け付けます。切り替えを使ってレスポンス構造を比較し、クライアントが想定するバージョンを選んでください。

レスポンスのバージョン V2

このページでバージョンを切り替えると、同じドキュメント URL でレスポンス構造を比較できます。

共通する点

認証、必須パラメーター、リクエストの形は V1 と V2 で同じです。実際には、エンドポイントのパスを組み立てるときとレスポンスを読み取るときにバージョンを選びます。

バージョン間で異なる点

主な違いはレスポンスのエンベロープです。新しい連携では V2 を使用し、既存のクライアント契約との互換性が必要な場合にのみ V1 を残してください。

使い方

メソッドの呼び出し方

どちらのバージョンでも、同じ API キーのヘッダーと同じクエリパラメーターを使用します。このドキュメントでは、まず共通のパラメーターを示し、次に各バージョンのパスとコードスニペットを示します。

入力パラメーター

共通パラメーター

パラメーター	必須	型	例	説明
`category`	はい	`all \| business \| creative \| education \| entertainment \| fashion-beauty \| food-beverage \| government-politics \| health-wellness \| non-profit \| other \| tech \| travel-tourism`	`all`	Linktree directory category slug. Example: all.
`page`	いいえ	`int`	`1`	Requested results page number. Example: 1.

バージョン別のリクエストパス

V2

エンドポイントの正確なパス、URL の例、コードスニペットをコピーするときにバージョンを選んでください。上のパラメーター一覧は変わりません。

GET /api/v2/linktr.ee/directory/users-by-category

正規化された形式

リクエストのプレビュー

ベース URL https://www.scrapestorm.net

エンドポイント /api/v2/linktr.ee/directory/users-by-category

必須パラメーター

コード例

curl --request GET \
  --url "https://www.scrapestorm.net/api/v2/linktr.ee/directory/users-by-category" \
  --header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
  --get --data-urlencode 'category=all' \
  # Optional parameters:
  # --data-urlencode 'page=1'

from urllib.parse import urljoin

import requests

BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v2/linktr.ee/directory/users-by-category"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}

params = {
    "category": "all",
}

# Optional parameters
# params["page"] = "1"

with requests.Session() as session:
    response = session.request(
        method="GET",
        url=urljoin(BASE_URL, ENDPOINT),
        headers=HEADERS,
        params=params,
        timeout=30,
    )
    response.raise_for_status()
    payload = response.json()

print(payload)

const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v2/linktr.ee/directory/users-by-category";

const params = new URLSearchParams({
  category: "all",
});

// Optional parameters
// params.set("page", "1");

const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
  method: "GET",
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}

const payload = await response.json();
console.log(payload);

import axios from "axios";

const client = axios.create({
  baseURL: "https://www.scrapestorm.net",
  timeout: 30000,
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

const params = {
  category: "all",
};

// Optional parameters
// params.page = "1";

const { data: payload } = await client.request({
  method: "GET",
  url: endpoint,
  params,
});

console.log(payload);

<?php

declare(strict_types=1);

use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;

$client = new Client([
    'base_uri' => "https://www.scrapestorm.net",
    'timeout' => 30.0,
    'headers' => [
        'Accept' => 'application/json',
        'X-API-Key' => "00000000-0000-4000-8000-000000000000",
    ],
]);

$query = [
    "category" => "all",
];

// Optional parameters
// $query["page"] = "1";

try {
    $response = $client->request("GET", "/api/v2/linktr.ee/directory/users-by-category", [
        'query' => $query,
    ]);

    $payload = json_decode(
        (string) $response->getBody(),
        true,
        512,
        JSON_THROW_ON_ERROR
    );

    var_dump($payload);
} catch (GuzzleException $e) {
    throw $e;
}

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "net/url"
    "time"
)

func main() {
    baseURL := "https://www.scrapestorm.net"
    endpoint := "/api/v2/linktr.ee/directory/users-by-category"

    params := url.Values{}
    params.Set("category", "all")

    // Optional parameters
    // params.Set("page", "1")

    req, err := http.NewRequest(
        "GET",
        fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
        nil,
    )
    if err != nil {
        panic(err)
    }

    req.Header.Set("Accept", "application/json")
    req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")

    client := &http.Client{Timeout: 30 * time.Second}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var payload any
    if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
        panic(err)
    }

    fmt.Printf("%+v\n", payload)
}

バージョン別のリクエストパス

V1

エンドポイントの正確なパス、URL の例、コードスニペットをコピーするときにバージョンを選んでください。上のパラメーター一覧は変わりません。

GET /api/v1/linktr.ee/directory/users-by-category

プラットフォーム固有の形式

リクエストのプレビュー

ベース URL https://www.scrapestorm.net

エンドポイント /api/v1/linktr.ee/directory/users-by-category

必須パラメーター

コード例

curl --request GET \
  --url "https://www.scrapestorm.net/api/v1/linktr.ee/directory/users-by-category" \
  --header "X-API-Key: 00000000-0000-4000-8000-000000000000" \
  --get --data-urlencode 'category=all' \
  # Optional parameters:
  # --data-urlencode 'page=1'

from urllib.parse import urljoin

import requests

BASE_URL = "https://www.scrapestorm.net"
ENDPOINT = "/api/v1/linktr.ee/directory/users-by-category"
HEADERS = {"Accept": "application/json", "X-API-Key": "00000000-0000-4000-8000-000000000000"}

params = {
    "category": "all",
}

# Optional parameters
# params["page"] = "1"

with requests.Session() as session:
    response = session.request(
        method="GET",
        url=urljoin(BASE_URL, ENDPOINT),
        headers=HEADERS,
        params=params,
        timeout=30,
    )
    response.raise_for_status()
    payload = response.json()

print(payload)

const BASE_URL = "https://www.scrapestorm.net";
const endpoint = "/api/v1/linktr.ee/directory/users-by-category";

const params = new URLSearchParams({
  category: "all",
});

// Optional parameters
// params.set("page", "1");

const response = await fetch(`${BASE_URL}${endpoint}?${params.toString()}`, {
  method: "GET",
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

if (!response.ok) {
  throw new Error(`Request failed: ${response.status} ${response.statusText}`);
}

const payload = await response.json();
console.log(payload);

import axios from "axios";

const client = axios.create({
  baseURL: "https://www.scrapestorm.net",
  timeout: 30000,
  headers: {
    Accept: "application/json",
    "X-API-Key": "00000000-0000-4000-8000-000000000000",
  },
});

const params = {
  category: "all",
};

// Optional parameters
// params.page = "1";

const { data: payload } = await client.request({
  method: "GET",
  url: endpoint,
  params,
});

console.log(payload);

<?php

declare(strict_types=1);

use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;

$client = new Client([
    'base_uri' => "https://www.scrapestorm.net",
    'timeout' => 30.0,
    'headers' => [
        'Accept' => 'application/json',
        'X-API-Key' => "00000000-0000-4000-8000-000000000000",
    ],
]);

$query = [
    "category" => "all",
];

// Optional parameters
// $query["page"] = "1";

try {
    $response = $client->request("GET", "/api/v1/linktr.ee/directory/users-by-category", [
        'query' => $query,
    ]);

    $payload = json_decode(
        (string) $response->getBody(),
        true,
        512,
        JSON_THROW_ON_ERROR
    );

    var_dump($payload);
} catch (GuzzleException $e) {
    throw $e;
}

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "net/url"
    "time"
)

func main() {
    baseURL := "https://www.scrapestorm.net"
    endpoint := "/api/v1/linktr.ee/directory/users-by-category"

    params := url.Values{}
    params.Set("category", "all")

    // Optional parameters
    // params.Set("page", "1")

    req, err := http.NewRequest(
        "GET",
        fmt.Sprintf("%s%s?%s", baseURL, endpoint, params.Encode()),
        nil,
    )
    if err != nil {
        panic(err)
    }

    req.Header.Set("Accept", "application/json")
    req.Header.Set("X-API-Key", "00000000-0000-4000-8000-000000000000")

    client := &http.Client{Timeout: 30 * time.Second}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    var payload any
    if err := json.NewDecoder(resp.Body).Decode(&payload); err != nil {
        panic(err)
    }

    fmt.Printf("%+v\n", payload)
}

レスポンス例

バージョン別のライブレスポンス

プレビューには主要なフィールドとコレクションの最初の要素が含まれているため、レスポンスの形をすばやく確認できます。バージョンを切り替えると JSON の形式が変わります。

レスポンス例

V2 レスポンスの JSON

検証済みの例

このコンパクトな JSON の例は、V2 の直近の成功した検証実行から取得したものです。

{
  "success": true,
  "status": "ok",
  "pagination": {
    "page": 1,
    "has_more": true
  },
  "search_context": {
    "page": 1,
    "category": "all"
  },
  "data": {
    "directory_context": {
      "selected_category": {
        "category_id": "all",
        "label": "All Categories"
      },
      "selected_subcategory": {
        "category_id": "all",
        "subcategory_id": "all",
        "label": "All"
      },
      "title": "Explore the Linktree community",
      "description": "Discover everything our most popular creators are sharing all over the internet, in one simple place."
    },
    "categories": {
      "count": 13,
      "items": [
        {
          "category_id": "all",
          "label": "All Categories"
        },
        {
          "category_id": "business",
          "label": "Business"
        },
        {
          "_more_items": 11
        }
      ]
    },
    "profiles": {
      "count": 18,
      "items": [
        {
          "username": "marjem",
          "display_name": "Marjem Kat",
          "url": "https://linktr.ee/marjem",
          "avatar_url": "https://example.com/image.jpg",
          "category": {
            "category_id": "other",
            "label": "Other"
          },
          "badges": [],
          "is_verified": false
        },
        {
          "username": "frontlinesmedia",
          "display_name": null,
          "url": "https://linktr.ee/frontlinesmedia",
          "avatar_url": "https://example.com/image.jpg",
          "category": {
            "category_id": "entertainment",
            "label": "Entertainment"
          },
          "badges": [],
          "is_verified": false
        },
        {
          "_more_items": 16
        }
      ]
    },
    "total_pages": 21112
  }
}

レスポンス例

V1 レスポンスの JSON

検証済みの例

このコンパクトな JSON の例は、V1 の直近の成功した検証実行から取得したものです。

{
  "success": true,
  "status": "ok",
  "search_context": {
    "page": 1,
    "category": "all"
  },
  "data": {
    "pageProps": {
      "profiles": [
        {
          "profileTitle": "Marjem Kat",
          "username": "marjem",
          "category": {
            "categoryId": "other",
            "label": "Other",
            "__typename": "Category"
          },
          "customAvatarUrl": "https://example.com/image.jpg",
          "profileBadges": null,
          "__typename": "FinderProfile",
          "verificationTick": false
        },
        {
          "profileTitle": null,
          "username": "frontlinesmedia",
          "category": {
            "categoryId": "entertainment",
            "label": "Entertainment",
            "__typename": "Category"
          },
          "customAvatarUrl": "https://example.com/image.jpg",
          "profileBadges": null,
          "__typename": "FinderProfile",
          "verificationTick": false
        },
        {
          "_more_items": 16
        }
      ],
      "categories": [
        {
          "__typename": "Category",
          "categoryId": "all",
          "label": "All Categories"
        },
        {
          "categoryId": "business",
          "label": "Business",
          "__typename": "Category"
        },
        {
          "_more_items": 11
        }
      ],
      "subCategoriesOfSelectedCategory": [],
      "selectedCategory": {
        "__typename": "Category",
        "categoryId": "all",
        "label": "All Categories"
      },
      "selectedSubCategory": {
        "categoryId": "all",
        "subCategoryId": "all",
        "label": "All",
        "numberOfProfiles": 0
      },
      "pageTitle": "Explore the Linktree community",
      "titleTag": "Explore the community | Linktree",
      "pageDescription": "Discover everything our most popular creators are sharing all over the internet, in one simple place.",
      "currentPage": 1,
      "totalPages": 21112,
      "isSearchEnabled": false,
      "isSurveyEnabled": false,
      "campaignVariation": null
    },
    "__N_SSP": true
  }
}

次のステップ

評価を続ける

このドキュメントを最初の判断材料とし、継続的な利用のためにエンドポイントを接続する前に、料金、プラットフォームのカバー範囲、連携ルールを確認してください。

Linktree のプラットフォームページを開く

実装の前に、関連するエンティティ、API メソッドのグループ、関連ドキュメントを比較してください。

プラットフォームページを開く

API メソッドの料金を比較する

利用を拡大する前に、公開料金表でこのメソッドの位置付けを確認してください。

料金を見る

連携ルールを確認する

入門ドキュメントで、認証、バージョン、再試行、テストと本番の違いを確認してください。

ドキュメントを開く

よくある質問

チームが実装前に尋ねる質問

これらの回答を参考に、この API メソッドがワークフロー、バージョンの選択、導入計画に合うかどうかを判断してください。

この Linktree API メソッドはどのようなデータを返しますか？

このメソッドはディレクトリに対して「カテゴリー別のユーザー」を実行します。以下のコンパクトなレスポンス例で、フィールドの正確な構造を確認できます。

V1 と V2 のどちらを選ぶべきですか？

新しい連携では、正規化された構造を提供する V2 を選んでください。V1 は、既にプラットフォーム固有の形式を処理しているクライアントとの互換性のためにのみ使用してください。

最初のリクエストには何が必要ですか？

API キーを作成し、リクエストヘッダーで送信し、表の必須パラメーターを指定してください。コード例には、正しいパスとリクエスト構造が既に含まれています。