組織エクスポートAPI

フォローする

Index

組織エクスポート API(CSV)

組織情報CSVを出力するためのAPIです。

HTTP メソッド

GET

URI

https://{sub-domain}.cybozu.com/v1/csv/organization.csv

リクエストヘッダ

ヘッダ 値と説明
X-Cybozu-Authorization 「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。
Authorization Basic認証を利用している場合、文字列「Basic 」と「ログイン名:パスワード」をBASE64エンコードしたものを値に指定します。
// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

リクエストボディ

必要なパラメータはありません。

レスポンス

組織情報 CSV が HTTP レスポンスボディに含まれています。
CSV フォーマットの詳細は 組織情報 CSV をご参照ください。

アクセス権

cybozu システム管理権限が必要です。

組織エクスポート API(JSON)

複数の組織情報をJSON形式で取得します。

HTTP メソッド

GET

URI

https://{sub-domain}.cybozu.com/v1/organizations.json

リクエスト

パラメータ

パラメータ名 指定する値 必須 説明
ids ID型配列 省略可 取得したい組織を組織のidの配列で指定します。下記codesと共に省略した場合は組織を全件取得します。※
上限値は100です。
codes 文字列配列 省略可 取得したい組織を組織のcodeの配列で指定します。上記idsと共に省略した場合には全件取得します。※
上限値は100です。
offset 数値 省略可 取得してきた組織情報の配列の中で、何番目のデータから結果を出力するかを指定します。
省略した場合は0になります。
size 数値 省略可 出力する配列のデータの最大件数です。省略した場合は100になります。
上限値は100です。

※idsとcodesは同時には指定できません。同時に指定した場合、エラーが返ります。

リクエストの例

クエリ文字列
ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=10
リクエストヘッダを含んだ文字列
GET /v1/organizations.json?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=10 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Typeヘッダは不要です。

レスポンス

パラメータ

パラメータ名 値の種類 説明
organizations organization型配列 組織情報の配列です。中のデータはid順(昇順)にソートされます。

レスポンスの例

アクセス権

全ユーザーがアクセス可能です。

※kintoneのゲストユーザはアクセスできません。

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk