Can I include private content in API responses?
Yes, you can retrieve private content by enabling the parameter (ignore_open_flg) in the relevant endpoint.
An endpoint with ignore_open_flg enabled also returns content that has not been published yet.
If access must be limited, review the API security settings and the endpoint permission settings as well. For details, see API security.
Endpoint settings
On the side menu, click [API] and click [Edit] for the target endpoint.
Under "Advanced settings", select the ignore_open_flg box and save these settings.
Response verification
On the endpoint list screen, click [Swagger UI].
Locate the target endpoint and click [Try it out].
Click [Execute].
You should see content whose publication setting is "Make private" included in the response.
Content under private categories or tags
If the category or tag is private, enable the following parameters as well.
| Parameter | Description |
|---|---|
ignore_category_open_flg | Select this to include content of private categories in the response. |
ignore_tag_open_flg | Select this to include content of private tags in the response. |
Content registered as unlisted
Content registered with "Display in list > No" is retrieved with get_unlisted_data, not ignore_open_flg. For the setup, see Can I retrieve unlisted content posts using API?.
Related documents
Support
If you have any other questions, please contact us or check out Our Slack Community.