Skip to content
ShaireDevelopers
Get a token

recurrences

4 endpoints.

get/api/recurrences#

tickets:read

Query

templateIdstring · uuid
Request
curl https://api.shairelabs.com/api/recurrences \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · TicketRecurrence[]

cadencestring*
dailyweeklymonthly
intervalinteger
min 1 · max 52 · default 1
weekdaysinteger[]
default []
dayOfMonthinteger | null
min 1 · max 31 · default null
hourinteger
min 0 · max 23 · default 9
timezonestring
min length 1 · max length 64 · default "UTC"
idstring · uuid*
workspaceIdstring · uuid*
templateIdstring · uuid*
listIdstring · uuid*
createdBystring · uuid*
dueInDaysinteger | null*
min 0 · max 3650
activeboolean*
nextRunAtstring*
lastSpawnedAtstring | null*
createdAtstring*
updatedAtstring*

Also answers 401 and 403. SeeErrors.

post/api/recurrences#

tickets:write

Body

cadencestring*
dailyweeklymonthly
intervalinteger
min 1 · max 52 · default 1
weekdaysinteger[]
default []
dayOfMonthinteger | null
min 1 · max 31 · default null
hourinteger
min 0 · max 23 · default 9
timezonestring
min length 1 · max length 64 · default "UTC"
templateIdstring · uuid*
listIdstring · uuid*
dueInDaysinteger | null
min 0 · max 3650 · default null
activeboolean
default true
Request
curl https://api.shairelabs.com/api/recurrences \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"cadence":"daily","templateId":"00000000-0000-0000-0000-000000000000","listId":"00000000-0000-0000-0000-000000000000"}'

Response · 201 · TicketRecurrence

cadencestring*
dailyweeklymonthly
intervalinteger
min 1 · max 52 · default 1
weekdaysinteger[]
default []
dayOfMonthinteger | null
min 1 · max 31 · default null
hourinteger
min 0 · max 23 · default 9
timezonestring
min length 1 · max length 64 · default "UTC"
idstring · uuid*
workspaceIdstring · uuid*
templateIdstring · uuid*
listIdstring · uuid*
createdBystring · uuid*
dueInDaysinteger | null*
min 0 · max 3650
activeboolean*
nextRunAtstring*
lastSpawnedAtstring | null*
createdAtstring*
updatedAtstring*

Also answers 401 and 403. SeeErrors.

patch/api/recurrences/{id}#

tickets:write

Path

idstring*

Body

cadencestring
dailyweeklymonthly
intervalinteger
min 1 · max 52
weekdaysinteger[]
dayOfMonthinteger | null
min 1 · max 31
hourinteger
min 0 · max 23
timezonestring
min length 1 · max length 64
listIdstring · uuid
dueInDaysinteger | null
min 0 · max 3650
activeboolean
Request
curl https://api.shairelabs.com/api/recurrences/$RECURRENCE_ID \
  -X PATCH \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · TicketRecurrence

cadencestring*
dailyweeklymonthly
intervalinteger
min 1 · max 52 · default 1
weekdaysinteger[]
default []
dayOfMonthinteger | null
min 1 · max 31 · default null
hourinteger
min 0 · max 23 · default 9
timezonestring
min length 1 · max length 64 · default "UTC"
idstring · uuid*
workspaceIdstring · uuid*
templateIdstring · uuid*
listIdstring · uuid*
createdBystring · uuid*
dueInDaysinteger | null*
min 0 · max 3650
activeboolean*
nextRunAtstring*
lastSpawnedAtstring | null*
createdAtstring*
updatedAtstring*

Also answers 401 and 403. SeeErrors.

delete/api/recurrences/{id}#

tickets:write

Path

idstring*
Request
curl https://api.shairelabs.com/api/recurrences/$RECURRENCE_ID \
  -X DELETE \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 204

Also answers 401 and 403. SeeErrors.