Get Posts
Post のデータを取得するエンドポイント
get/api/v1/data/posts
Request
- Base URL: https://dev.api-birdxplorer.code4japan.org (the document declares no server; this is the origin it was published from)
- URL: https://dev.api-birdxplorer.code4japan.org/api/v1/data/posts
- Auth: none declared
Query parameters
post_idsstring[] nullable
note_idsstring[] nullable
user_idsstring[] nullable
offsetinteger
取得する Post のリストの先頭からのオフセット。ページネーションに利用される。
ただし、レスポンスの meta.next や meta.prev で次のページや前のページのリクエスト用 URL が提供されるため、 そちらを利用したほうが良い場合もある。
limitinteger
取得する Post のリストの最大数。 0 ～ 1000 まで指定できる。ページネーションに利用される。
ただし、 meta.next や meta.prev で次のページや前のページのリクエスト用 URL が提供されるため、 そちらを利用したほうが良い場合もある。
search_textstring nullable
指定した文字列を含む Post を検索して取得する。検索は Post の本文に対して行われる。
search_urlstring uri nullable
指定した URL を含む Post を検索して取得する。
mediaboolean
Post に紐づいた画像や動画などのメディア情報を取得するかどうか。
必要に応じて false に設定することでメディア情報を取得しないようにできる。
languagestring nullable
取得するコミュニティノートの言語。
ISO 639-1 に準拠した 2 文字の言語コードを指定することで、その言語のコミュニティノートのみを取得できる。
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.