Resource URL

Returns an array of milestones

GET /milestones

Parameters

Table of allowed parameters.

_page	unsigned int	The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limit	unsigned int	The maximum number of resources to return. Default is 10 and maximum is 50.
_offset	unsigned int	The 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`.
_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

Filters

Filters can be used to filter through lists of milestones. You can defined filters in the _filter parameter.

standing (S1,S2,SN)	Array of standing status strings. For example standing(pending,active)- filter out milestones that do not have the supplied standing (status).
job (ID1,ID2,IDN)	Array of job IDs. For example, job(1,435,24) would only show milestones against jobs with ids 1, 435 or 24. If you want milestones for a single job we recommend you use the /jobs/:job_id/milestones endpoint.
parent (ID1,ID2,IDN)	Array of milestone IDs. For example, milestone(23) would return milestones with parent 23.
manager (ID1,ID2,IDN)	Array of staff IDs. For example, manager(1,2) would return milestones where the manager is either staff with ID 1 or 2.
status (ID1,ID2,IDN)	Array of milestone status IDs. For example, status(1,2) would only return milestones with status IDs 1 or 2. If you wish to search on a status string. Please use the standing filter.
rate (ID1,ID2,IDN)	Array of rate IDs. For example, rate(1,53,4) would only return milestones with rate with IDs 1, 53 or 4.
date_type_before (unix timestamp)	Accepts a unix timestamp. It will then filter milestones that have a timestamp before the supplied one. This supports types: created, modified, started, commenced, due and completed. For example, date_completed_before(<todays timestamp>) would only return milestones completed before today.
date_type_after (unix timestamp)	Accepts a unix timestamp. It will then filter milestones that have a timestamp after the supplied one. This supports types: created, modified, started, commenced, due and completed. For example, date_due_after(<todays timestamp>) would only return milestones due in the future (hopefully this is all of your jobs)
max_id	Only return milestones with id less or equal to max_id
min_id	Only return milestones with id greater or equal to min_id.
NEW <field_name>_greater_than(<value>), <field_name>_less_than(<value>), <field_name>_greater_than_or_equal(<value>), <field_name>_less_than_or_equal(<value>)	e.g. _filters=id_greater_than(1) Available fields: id job manager status modified_by rate rate_charged

Using the _not suffix (e.g, id_not) on standard in filters will return results not in.

For example: You may have a reporting screen that displayed a list of jobs retrieved using the /jobs/recent endpoint. Under each job you may wish to show an array of completed milestones that belong to the currently selected user.

/milestones.json?_filter=job(job_ids),manager(current_staff_id),standing(complete)

Handling the response

Returns an array of milestone objects. Please see GET milestone information.