Skip to main content
全読者一覧
curl --request GET \
  --url https://api.utage-system.com/v1/accounts/{account_id}/readers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "common_reader_id": "<string>",
      "scenario_id": "<string>",
      "scenario_fields": {},
      "common_fields": {},
      "line_display_name": "<string>",
      "line_picture_url": "<string>",
      "base_date": "<string>",
      "is_blocked": true,
      "is_line_blocked": true,
      "is_mail_error": true,
      "is_sms_blocked": true,
      "partner": {
        "name": "<string>"
      },
      "funnel_tracking_id": "<string>",
      "funnel_tracking_name": "<string>",
      "message_tracking_id": "<string>",
      "message_tracking_name": "<string>",
      "scenario_title": "<string>",
      "created_at": "<string>"
    }
  ],
  "meta": {
    "current_page": 123,
    "per_page": 123,
    "total": 123
  }
}
GET
https://api.utage-system.com/v1/accounts/{account_id}/readers
この機能はプレビュー版です。仕様が変更される場合があります。

Authorizations

Authorization
string
header
required

APIキーをBearerトークンとして指定

Path Parameters

account_id
string
required

アカウントID

Query Parameters

scenario_id
string

シナリオIDで絞り込み

conditions
string

配信条件構造による絞り込み。配列またはJSON文字列。 読者項目で使用できるキーは name / mail のみ(シナリオ横断のため)。不正なキー・演算子・空の rules は422になります。

page
integer

ページ番号

Required range: x >= 1
per_page
integer
default:20

1ページあたりの件数(既定20・最大100。超過時は100に丸められます)

Required range: 1 <= x <= 100

Response

読者一覧

data
object[]
meta
object