CLclio
Rate Table Timekeepers

Return the timekeepers on a rate table

Changed on

Returns the Users with a rate on the Rate Table in effect on as_of_date, ordered by User id. With include_groups=true and rate table groups turned on for the account, Groups are listed too, mixed with the Users and ordered by name. as_of_date defaults to today and can be any date, past or future. A timekeeper removed before that date, or scheduled to join after it, isn't listed. Archived tables can be listed.

get/rate_table_timekeepers.json

Request

  • Base URL
    https://app.clio.com/api/v4
  • URL
    https://app.clio.com/api/v4/rate_table_timekeepers.json
  • Auth
    none declared

Query parameters

as_of_datestring date

The date to apply, in YYYY-MM-DD format. Default: today. When listing, returns the timekeepers with a rate on the Rate Table in effect on this date, and can be any date. When removing, the timekeeper leaves the Rate Table on this date, which can't be in the past.

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

include_groupsboolean

Also list the Groups on the Rate Table, mixed with the Users and ordered by name; order is ignored. Ignored unless rate table groups are turned on for the account. Default: false.

limitinteger

A limit on the number of RateTableTimekeeper records to be returned. Limit can range between 1 and 200. Default: 200.

order'id(asc)' | 'id(desc)'

Orders the RateTableTimekeeper records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

rate_table_idinteger required

The unique identifier of the Rate Table.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok

Changes

  • 1587091ed74dRevision changes
    • warning

      removed the optional property /// from the response with the status

    • info

      added the new optional query request parameter include_groups

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • be032ea256b5Revision changes
    • info

      endpoint added