Apis::V4::StepSuggestions API

get challenge suggestions

Parameters

Name	Description
filters	filters include locale, self_step, pathway_stage_id, and status.If regional locale is given (with underscore or hyphen),and no suggestions are found, will fall back to non-regionallocale. If no suggestions are found for given locale, will fallback to english.

Response Fields

Name	Description
data	primary JSON API payload
meta	will contain additional information about the current request

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Host: example.org
Cookie:

Route

GET /apis/v4/challenge_suggestions

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
ETag: W/"eb53ba564a521ebcb732b98d68424b1a"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 558c5535-d6ac-4016-8dca-83486560b9aa
X-Runtime: 0.021991
Content-Length: 1662

Status

Body

{
  "data": [
    {
      "id": "1",
      "type": "challenge_suggestion",
      "attributes": {
        "challenge_type": "pray",
        "body": "Challenge 1",
        "locale": "en",
        "notification_message": null,
        "notification_delay": null,
        "self_step": true,
        "description_markdown": null,
        "status": "active",
        "pinned_at": null
      },
      "relationships": {
        "pathway_stage": {
          "data": {
            "id": "1",
            "type": "pathway_stage"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "challenge_suggestion",
      "attributes": {
        "challenge_type": "pray",
        "body": "Challenge 2",
        "locale": "en",
        "notification_message": null,
        "notification_delay": null,
        "self_step": true,
        "description_markdown": null,
        "status": "active",
        "pinned_at": null
      },
      "relationships": {
        "pathway_stage": {
          "data": {
            "id": "3",
            "type": "pathway_stage"
          }
        }
      }
    },
    {
      "id": "3",
      "type": "challenge_suggestion",
      "attributes": {
        "challenge_type": "pray",
        "body": "Challenge 3",
        "locale": "en",
        "notification_message": null,
        "notification_delay": null,
        "self_step": true,
        "description_markdown": null,
        "status": "active",
        "pinned_at": null
      },
      "relationships": {
        "pathway_stage": {
          "data": {
            "id": "3",
            "type": "pathway_stage"
          }
        }
      }
    },
    {
      "id": "4",
      "type": "challenge_suggestion",
      "attributes": {
        "challenge_type": "pray",
        "body": "Challenge 4",
        "locale": "en",
        "notification_message": null,
        "notification_delay": null,
        "self_step": true,
        "description_markdown": null,
        "status": "active",
        "pinned_at": null
      },
      "relationships": {
        "pathway_stage": {
          "data": {
            "id": "1",
            "type": "pathway_stage"
          }
        }
      }
    },
    {
      "id": "5",
      "type": "challenge_suggestion",
      "attributes": {
        "challenge_type": "pray",
        "body": "Challenge 5",
        "locale": "en",
        "notification_message": null,
        "notification_delay": null,
        "self_step": true,
        "description_markdown": null,
        "status": "active",
        "pinned_at": null
      },
      "relationships": {
        "pathway_stage": {
          "data": {
            "id": "4",
            "type": "pathway_stage"
          }
        }
      }
    }
  ],
  "meta": {
    "total": null
  }
}