利用者情報の検索 - PocketSign APIs

Requestパラメータ

Request Bodyパラメータapplication/json

page_size

integer <int32>

一度に取得する利用者情報の最大件数指定しない場合、デフォルト値(100件)が適用されます。

可選

page_token

string

取得するページのトークン前回のリクエストで取得した `next_page_token` を指定することで、残りのデータを取得することができます。指定しない場合、先頭のページから取得します。この値は一時的なものであり、再利用することはできません。

可選

filter

object (v2ListUsersRequestFilter)

可選

created_since

string <date-time>

取得対象に含める日時の範囲（開始）

可選

created_until

string <date-time>

取得対象に含める日時の範囲（終了）

可選

例

{
  "page_size": 0,
  "page_token": "string",
  "filter": {
    "created_since": "2019-08-24T14:15:22Z",
    "created_until": "2019-08-24T14:15:22Z"
  }
}

サンプルコード

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://verify.mock.p8n.app/pocketsign.verify.v2.UserService/ListUsers' \
--header 'Content-Type: application/json' \
--data-raw '{
    "page_size": 0,
    "page_token": "string",
    "filter": {
        "created_since": "2019-08-24T14:15:22Z",
        "created_until": "2019-08-24T14:15:22Z"
    }
}'

Response

🟢200A successful response.

application/json

Body

next_page_token

string

次のページを取得するためのトークンこの値をリクエストの `page_token` に指定することで、次のページを取得することができます。次のページがない場合は空文字列が返却されます。

可選

total_size

integer <int32>

検索条件に該当する利用者情報の総件数

可選

responses

array[object (v2GetUserResponse) {1}]

検索条件に該当する利用者情報

可選

user

object (利用者情報)

可選

例

{
  "next_page_token": "string",
  "total_size": 0,
  "responses": [
    {
      "user": {
        "id": "string",
        "created_at": "2019-08-24T14:15:22Z"
      }
    }
  ]
}

🔴500An unexpected error response.