Authentication
Provides the basic calls to authenticate with the REST API, get session information and access the correct data center where your organization is located

Data
Provides the calls to create, update, retrieve and delete objects in Clarizen as well as to query and search for objects

  • aggregateQueryPerforms a query and aggreagtes (and optionally groups) the results using one of the grouping functions (e.g. Count, Sum, etc.)
  • changeStateChanges the state of an object
  • countQueryPerforms a query and returns the result count
  • createAndRetrieveCreates and immediatly retrieves an entity
  • createDiscussionCreates a discussion message, link it related entities and notify users or groups
  • createFromTemplateCreates an entity from a predefined template
  • entityFeedQueryReturns the social feed of an object
  • entityQueryRetrieve entities from Clarizen according to a certain criteria
  • executeCustomActionExecutes custom action
  • expenseQueryRetrieves expenses for a specific Project or Customer
  • findUserQueryFinds a user based on several criterias
  • getCalendarInfoProvides information about calendar definitions in Clarizen. This API can provide information about the organization calendar or a user calendar
  • getTemplateDescriptionsReturns the list of template available for a certain Entity Type
  • groupsQueryReturns the list of groups the current user is a member of
  • lifecyclePerforms life cycle operations (Activate, Cancel etc.) on an entity
  • newsFeedQueryReturns the current user news feed
  • objectsA Uri representing a single entity in Clarizen
  • queryExecutes a CZQL query.
  • relationQueryRetrieve the related entities of an object from a specific Relation
  • repliesQueryRetrieves the reply feed of a discussion
  • retrieveMultipleRetrieves multiuple entities from the same entity type in a single request
  • searchPerforms a text search in a specific entity type or in all entity types
  • timesheetQueryRetrieves timesheet according to different criterias

Files
Provides the calls to upload and download files in Clarizen

  • downloadgets download information about a file attached to a document
  • getUploadUrlGet a URL for uploading files. After POSTing a file to this URL, perform an Upload operation and pass this URL in the UploadUrl parameter.
  • updateImageSet (Or Reset) the image of an object in Clarizen
  • uploadUpload file to a document in Clarizen

Metadata
Provides information about the Clarizen data model including supported entities, entity fields and data types, and relations between entities

Applications
Manage and install applications

Bulk
Allows clients to perform bulk operations

  • executeAllows executing several API calls in a single round trip to the server

Utils
General utility functions

  • appLoginConverts an API session to a web application session. Calling this method returns a url to the application that will not require credentials to login
  • sendEMailSend an email and attach it to an object in Clarizen