Browse the docs

List repeating visits

GET/api/v1/visit_series

Needs an API key, and runs with the access of the member who made the key.
A connected AI assistant can use it too, as listVisitSeries.

Parameters

In the query string

pageinteger
Default: 1. At least 1.
per_pageinteger
Default: 50. At least 1. At most 100.
job_idstring (uuid)

Responses

200Paginated repeating visits.

dataarray of objectrequired
Each item(18)
- lock_versionintegerrequired
  At least 0.
- created_atstring (date-time)required
- updated_atstring (date-time)required
- idstring (uuid)required
- account_idstring (uuid)required
- job_idstring (uuid)required
- intervalintegerrequired
  At least 1. At most 99.
- unitstringrequired
  `weekday` is Monday to Friday, one visit per working day, and needs an interval of 1.
  One of: day, weekday, week, month.
- starts_onstring (date)required
- ends_onstring (date) or null
- season_from_monthinteger or null
  `season_from_month` and `season_to_month` are the first and last month of the part of the year a series runs in, 1 for January to 12 for December, both included. Give both or neither. A season may run over the year end: 11 and 2 is November to February. Dates outside it are skipped; the rhythm is not restarted.
  At least 1. At most 12.
- season_to_monthinteger or null
  `season_from_month` and `season_to_month` are the first and last month of the part of the year a series runs in, 1 for January to 12 for December, both included. Give both or neither. A season may run over the year end: 11 and 2 is November to February. Dates outside it are skipped; the rhythm is not restarted.
  At least 1. At most 12.
- start_timestringrequired
- duration_minutesintegerrequired
- time_zonestringrequired
- instructionsstring or null
- membership_idsarray of string (uuid)required
- generated_throughstring (date) or null
  Visits exist up to this date.
metaobjectrequired
Fields(4)
- pageintegerrequired
  At least 1.
- per_pageintegerrequired
  At least 1. At most 100.
- totalintegerrequired
  At least 0.
- total_pagesintegerrequired
  At least 0.

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl "https://app.tradesender.co.uk/api/v1/visit_series?job_id=4088bebb-3a71-586f-922c-1612b3fa6557" \
  -H "Authorization: Bearer $TRADESENDER_KEY"