- Url
- data/entityQuery
- HTTP Method
POST
- Description
- Retrieve entities from Clarizen according to a certain criteria
- Parameters
-
Name Type Description typeName string The main entity type to query (e.g. WorkItem
,User
etc.)fields string[] A list of field names to retrieve orders orderBy[] Optionaly order the result where condition The query criteria deleted boolean If set to true, the query is performed on Deleted entities paging paging paging setting for the query - Result
- An object containing the results from a query
Name Type Description entities entity[] Array of entities returned from this query paging paging Paging information returned from this query. If paging.hasMore
is set to true, this object should be passed as is to the same query to retrieve the next pageIn case of failure an error object will be returned