Apis::V4::CommunityChallenge API

get all community challenges, sorted by active first, then created_at

Parameters

Name	Description
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)
filters	comma delimited filters. Filter options: - filters[organization_ids] = 1,null,3 (comma delimited list of organization ids to scope the items to, send "null" to filter for data that has no associated organization AKA global challenges)
include	(optional) comma delimited relationships you want included in the response in snake_case format
fields	A comma separated list of fields to return in the response for the given type. A resource object's attributes and its relationships are collectively called its 'fields'. Clients may restrict the set of fields in order to improve performance. Multiple types can be specified. If no fields param is specified then by default all fields are returned. Example

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.eyJ1c2VyX2lkIjoxMjcsImV4cCI6MTU0MDk0NDE4MCwiaWF0IjoxNTQwOTQ0MDAwfQ.WNoydKK00TnLi3XQje5TmrKJzixZMeLo5iSC3KdAMTU
Host: example.org
Cookie:

Route

GET /apis/v4/community_challenges?include=&sort=-active%2C-created_at

Query Parameters

include=
sort=-active,-created_at

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.eyJ1c2VyX2lkIjoxMjcsImV4cCI6MTU0MTExNjgwMCwiaWF0IjoxNTQwOTQ0MDAwfQ._XU2iXYgKIaNiy_rwX2VMUMg6YpQIMCydUl3yYzUA-w
Access-Control-Expose-Headers: X-MH-Session
ETag: W/"a69e745963c3df4623f4c53f2a134404"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e2e1319d-1788-4678-9f27-b6d7d55599e1
X-Runtime: 0.080716
Content-Length: 1713

Status

Body

{
  "data": [
    {
      "id": "20",
      "type": "community_challenge",
      "attributes": {
        "title": "Test community challenge 19",
        "details_markdown": null,
        "end_date": "2018-10-30",
        "created_at": "2018-10-23T23:00:00Z",
        "updated_at": "2024-01-05T16:44:10Z",
        "completed_count": 0,
        "accepted_count": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "89",
            "type": "organization"
          }
        },
        "creator": {
          "data": {
            "id": "234",
            "type": "person"
          }
        },
        "accepted_community_challenges": {
          "data": []
        }
      }
    },
    {
      "id": "21",
      "type": "community_challenge",
      "attributes": {
        "title": "Test community challenge 20",
        "details_markdown": null,
        "end_date": "2018-11-01",
        "created_at": "2018-10-16T23:00:00Z",
        "updated_at": "2024-01-05T16:44:10Z",
        "completed_count": 0,
        "accepted_count": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "89",
            "type": "organization"
          }
        },
        "creator": {
          "data": {
            "id": "234",
            "type": "person"
          }
        },
        "accepted_community_challenges": {
          "data": []
        }
      }
    },
    {
      "id": "18",
      "type": "community_challenge",
      "attributes": {
        "title": "Test community challenge 17",
        "details_markdown": null,
        "end_date": "2018-10-29",
        "created_at": "2018-10-09T23:00:00Z",
        "updated_at": "2024-01-05T16:44:10Z",
        "completed_count": 0,
        "accepted_count": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "89",
            "type": "organization"
          }
        },
        "creator": {
          "data": {
            "id": "234",
            "type": "person"
          }
        },
        "accepted_community_challenges": {
          "data": []
        }
      }
    },
    {
      "id": "19",
      "type": "community_challenge",
      "attributes": {
        "title": "Test community challenge 18",
        "details_markdown": null,
        "end_date": "2018-10-28",
        "created_at": "2018-10-02T23:00:00Z",
        "updated_at": "2024-01-05T16:44:10Z",
        "completed_count": 0,
        "accepted_count": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "90",
            "type": "organization"
          }
        },
        "creator": {
          "data": {
            "id": "234",
            "type": "person"
          }
        },
        "accepted_community_challenges": {
          "data": []
        }
      }
    }
  ],
  "meta": {
    "total": 4
  }
}