list-jobs-response.md

List Jobs Response

Represents a ListJobs response. Either jobs or errors is present in the response. If additional results are available, the cursor field is also present.

Structure

ListJobsResponse

Fields

Name	Type	Tags	Description	Getter	Setter
jobs	?(Job[])	Optional	The retrieved jobs. A single paged response contains up to 100 jobs.	getJobs(): ?array	setJobs(?array jobs): void
cursor	?string	Optional	An opaque cursor used to retrieve the next page of results. This field is present only if the request succeeded and additional results are available. For more information, see Pagination.	getCursor(): ?string	setCursor(?string cursor): void
errors	?(Error[])	Optional	The errors that occurred during the request.	getErrors(): ?array	setErrors(?array errors): void

Example (as JSON)

{
  "jobs": [
    {
      "created_at": "2021-06-11T22:55:45Z",
      "id": "VDNpRv8da51NU8qZFC5zDWpF",
      "is_tip_eligible": true,
      "title": "Cashier",
      "updated_at": "2021-06-11T22:55:45Z",
      "version": 2
    },
    {
      "created_at": "2021-06-11T22:55:45Z",
      "id": "FjS8x95cqHiMenw4f1NAUH4P",
      "is_tip_eligible": false,
      "title": "Chef",
      "updated_at": "2021-06-11T22:55:45Z",
      "version": 1
    }
  ],
  "cursor": "cursor6",
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "INVALID_EXPIRATION",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}