Skip to main content
GET
/
schedules
/
{schedule}
Get Schedule
curl --request GET \
  --url http://localhost/api/schedules/{schedule}
{
  "data": {
    "id": "<string>",
    "type": "schedules",
    "attributes": {
      "id": 123,
      "name": "<string>",
      "message": "<string>",
      "status": {
        "human": "<string>",
        "value": "<string>"
      },
      "scheduled": {
        "human": "<string>",
        "string": "<string>"
      },
      "completed": {
        "human": "<string>",
        "string": "<string>"
      },
      "created": {
        "human": "<string>",
        "string": "<string>"
      },
      "updated": {
        "human": "<string>",
        "string": "<string>"
      }
    },
    "relationships": {
      "components": {
        "data": [
          {
            "type": "components",
            "id": "<string>"
          }
        ]
      },
      "updates": {
        "data": [
          {
            "type": "updates",
            "id": "<string>"
          }
        ]
      }
    }
  }
}

Path Parameters

schedule
integer
required

The schedule ID

Query Parameters

include
string

Available includes are components, componentsCount, componentsExists, updates, updatesCount, updatesExists, user, userCount, userExists. You can include multiple options by separating them with a comma.

Response

Schedule

data
object
required