OfficeGest
Workshop/Schedules

List schedules

Returns a list of workshop schedules/appointments with optional filters and sorting.

GET
/workshop/schedules
AuthorizationBearer <token>

In: header

Query Parameters

order?string

Sort field

Value in"id" | "subject" | "plate" | "service_order" | "start_date" | "end_date" | "start_time" | "end_time" | "customer_id" | "place" | "priority" | "is_accomplished"
sorder?string

Sort direction (ASC, DESC)

Value in"ASC" | "DESC"
sort?string
limit?integer

Items per page. Default 50, maximum 250; a larger value is truncated to 250.

Default50
Range1 <= value <= 250
page?integer

Page number. Default 1; a value below 1 counts as 1.

Default1
Range1 <= value
filter?object

Filter criteria

Empty Object

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/workshop/schedules?order=id&sorder=ASC&sort=string&limit=50&page=1"
{
  "data": [
    {
      "id": 0,
      "subject": "string",
      "plate": "string",
      "service_order": {
        "number": 0,
        "document_number": "string"
      },
      "start_date": "string",
      "end_date": "string",
      "start_time": "string",
      "end_time": "string",
      "customer_id": 0,
      "customer_type": "string",
      "place": "string",
      "priority": 0,
      "is_accomplished": 0
    }
  ],
  "meta": {
    "per_page": 50,
    "current_page": 1,
    "has_more": true
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}