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↑
- getServerDefinitionReturns the Url where your organization API is located
- getSessionInfoReturns information about the current session
- loginLogin to the API
- logoutTerminate the current API session
Data
Provides the calls to create, update, retrieve and delete objects in Clarizen as well as to query and search for objects↑
- changeState
- 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
- download
- entityFeedQueryReturns the social feed of an object
- entityQueryRetrieve entities from Clarizen according to a certain criteria
- 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
- lifecycleMessageWithIObjects
- newsFeedQueryReturns the current user news feed
- objectsA Uri representing a single entity in Clarizen
- repliesQueryRetrieves the reply feed of a discussion
- retrieveMultipleRetrieves multiuple entities from the same entity type in a single request
- timesheetQueryRetrieves timesheet according to different criterias
- upload
Metadata
Provides information about the Clarizen data model including supported entities, entity fields and data types, and relations between entities↑
- describeEntitiesReturns information about an Entity Type in Clarizen, including its fields, relations and states
- describeEntityRelationsDescribes the relation between entities
- describeMetadata
- getSystemSettingsValuesRetrieves the values of a system settings
- listEntitiesReturns the list of entity types available for your organization
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