Staff

  • Return all of the user's staff

    GET /api/1/staff.json
    Formats
    json jsonp

    Returns an array of staff objects belonging to authenticated user. The authenticated user is included in the results. Can take a URL-encoded, SQL-like query string and order string which can help filter and order the results that will be returned. So the query string:

    active = "true"

    which lookes like this when URL encoded:

    /api/1/staff.json?where=active%3D"true"&order=last_name+asc

    will return all active staff ordered by last name in ascending order.

    Click here for more information on the API query string.

    Errors
    • 401 Unauthorized
    Example
    GET /api/1/staff
    200
    {
      "response": [
        {
          "active": "true",
          "email_address": "19anita.pacocha@oreilly.info",
          "first_name": "Lola",
          "hourly_rate_cents": null,
          "last_name": "Kuphal",
          "login": "user19",
          "time_zone": "Australia/Perth",
          "uuid": "07f971d7-e6ae-437c-bdb5-12e45a12cb81",
          "type": "manager"
        },
        {
          "active": "true",
          "email_address": "20angelita.brown@marquardt.com",
          "first_name": "Geovanni",
          "hourly_rate_cents": 10000,
          "last_name": "Pollich",
          "login": "user20",
          "time_zone": "Australia/Perth",
          "uuid": "a00ca7ce-20b6-4b2f-9153-46f6b8e5b6bc",
          "type": "staff"
        },
        {
          "active": "true",
          "email_address": "21lisa_johnston@moriette.com",
          "first_name": "Keyon",
          "hourly_rate_cents": 7000,
          "last_name": "Okuneva",
          "login": "user21",
          "time_zone": "Australia/Perth",
          "uuid": "eea4f769-9581-4b8d-ae47-79a1cd0ca304",
          "type": "staff"
        },
        {
          "active": "true",
          "email_address": "22keara@wuckert.info",
          "first_name": "Bettie",
          "hourly_rate_cents": 9500,
          "last_name": "Grady",
          "login": "user22",
          "time_zone": "Australia/Perth",
          "uuid": "262ae5f3-49ad-429e-85b0-2002ca3b6723",
          "type": "staff"
        }
      ],
      "count": 4
    }
    Parameters
    • where

      An SQL-like query string which can filter the results that will be returned

    • order

      An SQL-like order string, that sets the order of the returned objects