Agendize Client API

Activities


Resource representation

{ "id": {string}, "type": {string}, "title": {string}, "date": { "dateTime": {datetime}, "timeZone": {string} }, "selfLink": {string} }
Parameter name Value Description
id string Identifier of the activity.
type string Type of the activity. Values: 'appointment', 'call', 'note', 'email', 'sms'
title string Title of the activity.
date object The date time of the activity.
date.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
date.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.
selfLink string URL link to the activity resource description.

List

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/activities

Parameters

Parameter name Value Description
Required query parameters
clientId string Search activities for a client identifier.
Optional query parameters
startDate datetime Upper bound (exclusive) for an appointment's start time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by start time.
endDate datetime Lower bound (exclusive) for an appointment's end time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by start time.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Activity Resource] }