Skip to content

Get widget config

Returns a project’s public widget configuration: the display settings a widget or mobile app needs to render itself, such as whether voting is enabled and the title to show. It powers the embeddable widget and custom integrations.

GET /api/projects/{id}/config

None. This endpoint is public so a widget or mobile app can read its configuration from a visitor’s device without exposing an API token. Only non-sensitive display settings are returned.

ParameterTypeDescription
idstringThe project whose configuration you want.
Terminal window
curl https://updatify.io/api/projects/PROJECT_ID/config

200 OK with a JSON object containing a data object.

{
"data": {
"voting_enabled": true,
"widget_title": "What's new"
}
}
FieldTypeDescription
voting_enabledbooleanWhether the up/downvote section should be offered for this project’s updates.
widget_titlestring | nullTitle shown at the top of the widget, or null if the project hasn’t set one.
StatusMeaning
404 Not FoundNo project exists with the given ID.

See Errors for details.