GuidesAPI Reference
API Reference

List appeals

get
https://api.joyful.org/platforms//appeals

Returns a list of appeals. If there are no appeals, the list will be empty.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
uuid

Filter appeals by the parent appeal id. The value should be the unique GUID of the parent appeal's id.

string

Filter appeals by matching title or appeal id. The value should be a string and can either be a full or partial search term.

boolean

Filter appeals by whether they are featured or not. By default all featured and non-featured appeals will be returned.

string

Filter appeals by the appeal's slug.

boolean

Filter appeals by whether they are live on the public website. If set to true, active and approved appeals will be returned.

category
array of strings

Filter appeals by category, using the category's slug. To filter on multiple categories, pass in multiple query string values (e.g. ?category=one&category=two)

category
string
enum

Filter appeals by appeal type.

Allowed:
int32
int32
Responses

401

Unauthorized

403

Forbidden

404

Not Found

Updated 3 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago