Appointments APIs

Parameters

• fieldsstring, mandatory when fetching all appointments data

  To list all the appointments data with respect to the fields that you specify in this parameter. Note that you can include a maximum of 50 field API names in this parameter. The GET Fields API will give you the existing field API names in the Appointments module.
  Possible values: Multiple field API names, comma separated. For example: Last_Name,Email.

• cvidlong, optional

  To get the list of appointments present in a custom view that you specify in this key. You can get the custom view ID from the GET Custom Views API. You cannot use this param with the "sort_by" param.
  Possible values: {custom_view_id}.

• page_tokenstring, mandatory to fetch more than 2000 appointments by pagination

  You can use the "page" param to fetch up to 2000 appointments without "page_token". To fetch more than 2000 appointments, you must include the "page_token" param in the request. This param takes the value from the key "next_page_token" in the response of the first GET Appointments call. This token value is user-specific and if you use another user's token, the system will throw an error.
  The page token is bound to parameters and expires in 24 hours. Also, you cannot use this param with the "page" param.

• pageinteger, optional

  To get the list of appointments from the respective pages. The default value is 1. Note that you cannot use this param with the "page_token" param.
  Possible values: Positive integer values only.

• per_pageinteger, optional

  To get the list of appointments available per page. The default and the maximum possible value is 200.
  Possible values: Positive integer values only.

• sort_orderstring, optional

  To sort the available list of appointments in either ascending or descending order.
  Possible values: asc - ascending order, desc - descending order. The default value is 'desc'.

• sort_bystring, optional

  To sort the appointments based on the fields id, Created_Time, and Modified_Time. Note that you cannot use this param with the "cvid" param. The default field is 'id'.

Possible Errors

• AMBIGUITY_DURING_PROCESSINGHTTP 400

  You cannot use both cvid and sort_by, and page and page_token
  Solution: Use either "cvid" or "sort_by" param in the request. Similarly, use either "page" or "page_token" in the request.

• DISCRETE_PAGINATION_LIMIT_EXCEEDEDHTTP 400

  You can only get the first 2000 records without using page_token param.
  Solution: If you want to fetch more than 2000 records, you must use the "page_token" param.

• EXPIRED_VALUEHTTP 400

  Your page token has expired.
  Solution: page_token is valid only for 24 hours from the time it was generated.

• INVALID_DATAHTTP 400

  You have used an invalid page_token or the one generated by another user.
  Solution: page_token is user-specific. Use the one generated from your API call.

• INVALID_MODULEHTTP 400

  You have given an invalid module name in the request URL.
  Solution: You can use only Appointments__s in the request URL.

• INVALID_REQUEST_METHODHTTP 400

  You have given an invalid http request method type.
  Solution: Use only GET method in the request URL to access this API.

• LIMIT_EXCEEDEDHTTP 400

  You exceeded the field limits.
  Solution: You can only include a maximum of 50 field API names in the "fields" param.

• TOKEN_BOUND_DATA_MISMATCHHTTP 400

  You have either specified an invalid page_token or the input param is added, altered, or deleted.
  Solution: The page_token is bound to the parameters used in the request. Do not change the parameters and use the page token from the response.

• PAGINATION_LIMIT_EXCEEDEDHTTP 400

  You can only get up to first 100,000 records using page_token param.
  Solution: You can fetch a maximum of 100,000 records using the page_token param in the response of GET appointments API.

• REQUIRED_PARAM_MISSINGHTTP 400

  You failed to specify either the field API names or page token in the parameter.
  Solution:It is mandatory to specify the field API names when you want to get the data of all the appointments. The page token is mandatory to provide appointments more than 2000.

• INVALID_TOKENHTTP 401

  You have used an invalid oauth token.
  Solution: The access token you used has expired. Kindly refresh your token and retry.

• OAUTH_SCOPE_MISMATCHHTTP 401

  You created the grant token using the wrong oauth scope.
  Solution: Use either ZohoCRM.modules.appointments.READ or ZohoCRM.modules.appointments.ALL scope to create a new valid grant token.

• NO_PERMISSIONHTTP 403

  You do not have permission to get any data of appointments.
  Solution: Contact your system administrator.

• INVALID_URL_PATTERNHTTP 404

  Check if you are trying to access the correct URL.
  Solution: You have given an invalid request URL. Refer to the above endpoints section.

• INTERNAL_ERRORHTTP 500

  Internal Server Error
  Solution: Unexpected and unhandled exception in the server. Please contact our support team.