Apis::V4::Challenge API

get filtered challenges

Parameters

Name Description
access_token JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
page pagination details:
- page[limit] = number of challenges you want to receive per page, default 25
- page[offset] = skip the first n number of records before reading challenges, default 0
sort (optional) order you want to receive challenges in, defaults to id.
include (optional) comma delimited relationships you want included in the response in snake_case format
filters comma delimited filters. Filter options:
- filters[completed] = [true,false]
- filters[receiver_ids] = 3,4
- filters[organization_ids] = 1,2
- filters[types] = pray,learn

Response Fields

Name Description
data primary JSON API payload
included related models (controlled by the include param)
meta will contain additional information about the current request, including the total number of records before the limit/offset operations

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMDIsImV4cCI6MTcwNDQ3MzIyOSwiaWF0IjoxNzA0NDczMDQ5fQ.vMqkzS5Cv7xviubzfr_aaG9D7UAb2DZo92Lg3qGNfNE
Host: example.org
Cookie: 

Route

GET /apis/v4/challenges?include=&filters[organization_ids]=77&filters[completed]=false&filters[receiver_ids]=212&filters[types]=pray

Query Parameters

include=
filters={"organization_ids"=>"77", "completed"=>"false", "receiver_ids"=>"212", "types"=>"pray"}

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
X-MH-Session: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxMDIsImV4cCI6MTcwNDY0NTg0OSwiaWF0IjoxNzA0NDczMDQ5fQ.fjbRwEw9nczaq-7DvzD4c0O6KtbbyRzDsQ8rlaTczjo
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"92d51c616bacdd69444a854a53601523"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 0e799ac5-d776-445c-9e23-8d267362ca29
X-Runtime: 0.039609
Content-Length: 532

Status

200

Body