Sign in
Visits

Get All

Get all the visits.

get/public/api/visits?filter={filter}

Query parameters

filterstring

A valid JSON filter object

Headers

Acceptstring

e.g. application/json

Request body

Example request

{
  "Authorization": {
    "Authorization": "Bearer JWT"
  }
}

Response

OK

visit_idstring required
typestring required
descriptionstring
user_idstring required
creator_idstring required
store_idstring required
visit_datestring required
start_timestring required
end_timestring required
compliantboolean
created_datestring required
updated_datestring required

Example response

[
  {
    "visit_id": "54ab03c6546847ee0d30084a",
    "type": "stocktaking",
    "description": "Approved store visit.",
    "user_id": "5d160d2486191e003b3e538b",
    "creator_id": "5aaf8a1bad9a1800354732bd",
    "store_id": "5d160a327411ab005c986216",
    "visit_date": "2019-09-04T00:00:00.000Z",
    "start_time": "17:00",
    "end_time": "18:30",
    "compliant": true,
    "created_date": "2019-09-04T08:24:30.793Z",
    "updated_date": "2019-09-04T08:24:30.793Z"
  },
  {
    "visit_id": "5d4bdc3e1fca0e003b469a7f",
    "type": "stocktaking",
    "user_id": "5d160d2486191e003b3e538b",
    "creator_id": "5aaf8a1bad9a1800354732bd",
    "store_id": "5ae065ec5d77d00035a6e9fb",
    "visit_date": "2019-09-04T00:00:00.000Z",
    "start_time": "12:00",
    "end_time": "13:30",
    "created_date": "2019-09-04T08:24:30.793Z",
    "updated_date": "2019-09-04T08:24:30.793Z"
  }
]

Changes

No recorded changes to this endpoint across all 4 revisions of this API.