スペース

備考
エキスパートレベル
APIキーは、リクエストのAuthorizationヘッダーのBearerトークンとして送信されなければならない。 APIキーを取得する.
リスト

APIエンドポイント:

GET 
https://goo.vc/api/v1/spaces?ja

リクエスト例: 

curl --location --request GET 'https://goo.vc/api/v1/spaces?ja' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
パラメータ
タイプ
説明
search
オプション string
検索クエリ。
search_by
オプション string
で検索. 可能な値は以下の通り：000名称用. デフォルトはname.
sort_by
オプション string
並べ替え. 可能な値は以下の通り：000作成日用, 000名称用. デフォルトはid.
sort
オプション string
ソート. 可能な値は以下の通り：000下降用, 000上昇用. デフォルトはdesc.
per_page
オプション integer
ページあたりの結果. 可能な値は以下の通り：10, 25, 50, 100. デフォルトは10.
ショー

APIエンドポイント:

GET 
https://goo.vc/api/v1/spaces/{id}?ja

リクエスト例: 

curl --location --request GET 'https://goo.vc/api/v1/spaces/{id}?ja' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
店舗

APIエンドポイント:

POST 
https://goo.vc/api/v1/spaces?ja

リクエスト例: 

curl --location --request POST 'https://goo.vc/api/v1/spaces?ja' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}'
パラメータ
タイプ
説明
name
必須 string
スペース名。
color
オプション integer
カラーコードだ。 可能な値は以下の通り：1, 2, 3, 4, 5, 6. デフォルトは1.
更新

APIエンドポイント:

PUT PATCH 
https://goo.vc/api/v1/spaces/{id}?ja

リクエスト例: 

curl --location --request PUT 'https://goo.vc/api/v1/spaces/{id}?ja' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
パラメータ
タイプ
説明
name
オプション string
スペース名。
color
オプション integer
カラーコードだ。 可能な値は以下の通り：1, 2, 3, 4, 5, 6.
削除

APIエンドポイント:

DELETE 
https://goo.vc/api/v1/spaces/{id}?ja

リクエスト例: 

curl --location --request DELETE 'https://goo.vc/api/v1/spaces/{id}?ja' \
--header 'Authorization: Bearer {api_key}'