Sign in
Steps

Get all steps by guide ID

Changed on

Retrieves a page of steps for a guide ordered by sort_order. Pass the previous page's next_cursor to continue.

get/api/v1/steps

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/steps
  • Auth: none declared

Query parameters

guide_idstring
cursorstring
limitinteger

Response

OK

next_cursorstring nullable required
totalinteger required

Example response

{
  "steps": [
    {
      "guide_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "media_assets": [
        {
          "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
          "step_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        }
      ]
    }
  ]
}

Changes

  • 1cef0ffac54aRevision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter limit

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • a294b480da05Revision changes
    • warning

      added the new keypress enum value to the ////// response property for the response status