一覧 - Nitte SDK

Requestパラメータ

Authorization

Headerにパラメータ

Authorization

を追加し、その値にはBearerの後にTokenを連結します

例：

Authorization: Bearer ********************

Pathパラメータ

teamId

string

必須

Queryパラメータ

query

string

可選

管理名 / 公開名 / メールアドレス

サンプル値:

nitte@example.com

page

number

可選

ページ数

サンプル値:

0

hitsPerPage

number

可選

1ページあたりの取得数

サンプル値:

5

サンプルコード

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.nitte.app/mediatories//clients?query=nitte@example.com&page=0&hitsPerPage=5'

Response

🟢200成功

application/json

Body

clients

array[object (企業担当者) {8}]

必須

id

string

必須

ID

サンプル値:

c1be87a5-d8ff-4338-a60a-ad8792b99ee6

email

string

必須

メールアドレス

サンプル値:

nitte@exmaple.com

publicName

string

必須

公開名

サンプル値:

Nitte株式会社

privateName

string

必須

管理名

サンプル値:

client-12345

tel

string | null

必須

電話番号

サンプル値:

08012341234

lineUserId

string | null

必須

LINE UserID

blockedPeriods

array[object (時間帯) {2}]

必須

調整不可の時間帯

preProposedPeriods

array[object (時間帯) {2}]

必須

登録された候補日時

page

number

必須

現在のページ

hitsPerPage

number

必須

1ページあたりのレコード数

numberHits

number

必須

全体のレコード数

例

{
    "clients": [
        {
            "id": "c1be87a5-d8ff-4338-a60a-ad8792b99ee6",
            "email": "nitte@exmaple.com",
            "publicName": "Nitte株式会社",
            "privateName": "client-12345",
            "tel": "08012341234",
            "lineUserId": "string",
            "blockedPeriods": [
                {
                    "start": "2019-08-24T14:15:22Z",
                    "end": "2019-08-24T14:15:22Z"
                }
            ],
            "preProposedPeriods": [
                {
                    "start": "2019-08-24T14:15:22Z",
                    "end": "2019-08-24T14:15:22Z"
                }
            ]
        }
    ],
    "page": 0,
    "hitsPerPage": 0,
    "numberHits": 0
}

🟠401Unauthorized

🟠404NotFound

🟠422Unprocessable Entity

🔴500InternalServerError