Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

Resource URL

Returns an array of staff members.

GET /staff
ANY /staff?_method=get

Parameters

Table of allowed parameters.

_pageunsigned intThe page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limitunsigned intThe maximum number of resources to return. Default is 10 and maximum is 50.
_offsetunsigned intThe position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page.
_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response.

Handling the response

For handling the response, please seeĀ GET staff/:id.

Sample Response

GET /staff.json?_fields=email&_limit=2
{
   "response" : [
      {
         "firstname" : "AffinityLive",
         "email" : "system@affinitylive.com",
         "id" : "1",
         "surname" : "System"
      },
      {
         "firstname" : "John",
         "email" : "john.david@internetrix.com.au",
         "id" : "23",
         "surname" : "David"
      }
   ],
   "meta" : {
      "status" : "ok",
      "message" : "Everything executed as expected."
   }
}
  • No labels