UNDER DEVELOPMENT

The following endpoint can be used to list contracts in the deployment.

GET /contracts

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	partial string	Allows you to filter contacts. For more information on available filters, please see the filter action.
_search	string	Allows you to search for a company (searches title)

Filtering Contracts

You can filter the returned list using the _filters parameter.

Name	Example	Description
id	id(12,32)	Only return contracts by given ids
type(<values>)	type(12, 44)	Only return contracts by given type ids.
billable(<values>)	billable(44, 887)	Only return contracts by given billable ids.
standing(<values>)	standing(active)	Only return contracts by given standing statuses.
manager	affiliation(23, 55)	Only return contracts by given manager ids.
status	status(12, 15)	Only return contracts by given status ids.
owner	owner(22, 867)	Only return contracts by given owner ids
against	against(company(1,4))	Only return contracts with the matching against values. The example will only return tasks against company 1 and 4
against_type	against_type(company)	Only return contracts that are against a specific object type.
against_id	against_id(33, 874)	Only return contracts against an object with id.
date_expires_before	date_expires_before(1341281246)	Unix Timestamp. e.g 1341281246- Filter out contracts that were not expiry before this date.
date_expires_after	date_expires_after(1341281246)	Unix Timestamp. e.g 1341281246- Filter out contracts that were not expiry after this date.
date_started_before	date_started_before(1341281246)
date_started_after	date_started_after(1341281246)
date_period_expires_before	date_period_expires_before(1341281246)
date_period_expires_after	date_period_expires_after(1341281246)
date_created_before	date_created_before(1341281246)
date_created_after	date_created_after(1341281246)
order_by_asc(<type>), order_by_desc(<type>)	_filters=order_by_desc(id)	Accepts: id, date_expires, date_created, date_started, date_period_expires, date_last_interacted, title, standing and status
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>)	_filters=id_greater_than(5)	Available fields: id type billable affiliation manager against_id status value renew_days period_template service_tax service_ledger

Handling the response

Please see the get contract for controlling the response.