API Docs

/

No Results Found

Pagination

Introduction
- Overview
- Authentication
- Networks
- Multiple Data Centers
Authentication
Introduction to OAuth 2.0
- Overview
- Terminologies
- Scopes
Register your application
- Overview
API Reference
HTTP Methods
- Overview
Pagination
- Overview
- Token Reference
Errors
- Overview
Glossary
- Overview
- CHAT_ID
- MESSAGE_ID
- THREAD_CHAT_ID
- SCHEDULED_MESSAGE_ID
- FILE_ID
- CHANNEL_ID
- CHANNEL_UNIQUE_NAME
- REMINDER_ID
- EVENT_ID
- BOT_UNIQUE_NAME
- BOT_ID
- SLASH_COMMAND_ID
- MESSAGE_ACTION_ID
- EXTENSION_ID
- EXTENSION_KEY
- EXTENSION_PROPERTY_KEY_NAME
- FUNCTION_ID
- WIDGET_ID
- MAP_ID
- DATASTORE_ID
- DATABASE_UNIQUE_NAME
- RECORD_ID
- USER_ID
- EMAIL_ID
- STATUS_ID
- USER_FIELD_ID
- DEPARTMENT_ID
- DESIGNATION_ID
- TEAM_ID
- ROLE_ID
OpenAPI Specification (OAS)
OpenAPI Specification (OAS)
- Overview
- Why use the OAS?
- Swagger API Hub
- Download OAS
Postman Collection
Postman Collection
- Overview
- What's in the collection?
- Why use the collection?
- Prerequisites
- Using the collection
- Keeping your fork up to date
- Data center configuration
User & Organization Management
Users
- Overview
- Add Users
- Retrieve all users
- Update user details
- Retrieve a particular user
- Fetch list of user teams
- List user field layouts
User Status
- Overview
- Add a new status
- Retrieve all statuses
- Add a transient status
- Delete transient status
- Retrieve current status
- Retrieve a user's status
- Update current status
- Delete status
Userfields
- Overview
- Add a userfield
- Get all userfields
- Update a userfield
- Retrieve a particular userfield
- Delete a userfield
Roles
- Overview
- Create a Role
- Get Roles
- Edit a Role
- Retrieve role details
- Delete a Role
- Update permissions of a role
- Get permissions of a role
- Add users to a role
- Get users in a role
- Delete users from a role
Departments
- Overview
- Create a Department
- List all Departments
- Update Department
- Get Department Details
- Delete Department
- Add Department Members
- Get Department Members
- Delete Department Members
Designations
- Overview
- Create a Designation
- Get Designation Details
- Update Designation
- Get Designation Details
- Delete Department
- Add Designation Members
- Get Designation Members
- Delete Designation Members
Teams
- Overview
- Create a Team
- List all Teams
- Update a Team
- Retrieve a Team
- Delete a Team
- Add Team Members
- Get Team Members
- Delete Team Members
Communication & Collaboration
Chats
- Overview
- Retrieve all direct chats
- Retrieve the members of a chat
- Mute a chat
- Unmute a chat
- Pin a message
- Retrieve a pinned message
- Unpin a message
- Leave a group chat
Messages
- Overview
- Get Messages
- Retrieve a message
- Post message in a channel
- Post message to a bot
- Post message in chat
- Post message to a user
- Edit a message
- Delete a message
- Add a reaction
- Get Reactions
- Delete a reaction
Threads
- Overview
- Create and send a thread message
- Send a message to an existing thread
- Get threads of a channel
- Auto follow
- Add followers to a thread
- Get thread followers
- Remove followers from a thread
- Get non-followers of a thread
- Join (follow) a thread
- Leave (unfollow) a thread
- Update the state of a thread
- Get main message of a thread
Channels
- Overview
- Create a channel
- List all channels
- Update a channel
- Retrieve a channel
- Delete a channel
- Add Channel Members
- Get Channel Members
- Delete Channel Members
- Add a Bot to a Channel
- Update a Channel members role
- Approve a Channel
- Reject a Channel
- Join a Channel
- Leave a Channel
- Archive a Channel
- Unarchive a Channel
Scheduled Messages
- Overview
- Send a scheduled message
- Get the list of scheduled messages
- Update a scheduled message
Reminders
- Overview
- Create a reminder
- Get list of all reminders
- Update a reminder
- Retrieve a reminder
- Delete a reminder
- Delete Reminders
- Delete completed reminders
- Mark a reminder as complete
- Mark a reminder as incomplete
- Snooze a reminder
- Dismiss a snoozed reminder
- Assign users to a reminder
- Unassign a user from a reminder
- Remind assignee
- Remind assignees
Meetings & Events
Calls & Meetings
- Overview
- History
- Get Participants
Events
- Overview
- Get Calendars
- Create an Event
- Get Events
- Edit an Event
- Get Event Details
- Delete an Event
- Update an Event Status
- Upload Attachments to Event Calendar
Remote Work
Remote Work
- Overview
- Get remote status
- Trigger Remote Check in
- Trigger Remote Check out
Developer Platform
Databases
- Overview
- Add a record
- List records
- Update a record
- Retrieve a record
- Delete a record
Widget Map Tickers
- Overview
- Add/Update a ticker
- Delete a ticker
File and Data Management
Files
- Overview
- Get Files
- Share files to a channel
- Share files to a bot
- Share files in a chat
- Share files to a user
Maintenance - Bulk Export
- Overview
- Export Conversations
- Export Channels
- Export Members in a Conversation
- Export Messages
Customization
Custom Domain
- Overview
- Add a custom domain
- Verify a custom domain
- Retrieve a custom domain
- Delete a custom domain
Custom Email
- Overview
- Update mail configuration
- Retrieve global mail configuration
- Reset mail configuration
Custom Themes
- Overview
- Create custom theme
- Get all themes
- Update custom theme
- Get specific theme
- Delete custom theme
Message Components
Message Content
- Overview
- Plain text
- Table
- List
- Label
- Image
- Charts
- Graphs
Mentions
- Overview
- Mentioning a User
- Silent mentions
- Mentioning a Channel
- Mentioning all users in a channel
- Mentioning available users in a Channel
- Mentioning a Team
Buttons
- Overview
- Message card buttons
- Confirmation popup
Message Cards
- Overview
- Post a Message Card to a Channel
- Post a Message Card to a User

Pagination LEGACY AI Tools

Open in ChatGPT

Open in ChatGPT to ask questions about this page

Open in Claude

Open in Claude to ask questions about this page

Copy as Markdown

Copy this page as markdown to use with AI assistants

View as Markdown

Open this page as markdown in a new tab

The Zoho Cliq REST API v2 uses cursor-based pagination on list endpoints. Token names vary by module, but the behavior is consistent: pass the token from the previous response to fetch the next page. When the token is absent, you have reached the last page.

The token name, default limit, and maximum limit are documented on each endpoint page.

Token reference by module

Module	Token name	Also supports
Bots	`next_token`	`sync_token`
Channels	`next_token`	`sync_token`
Chats	`next_token`	N/A
Threads (in a chat)	`next_token`	`next_search_token` when `search_key` is used
Messages (search)	`next_token`	N/A
Pin Messages	`next_token`	`sync_token`
Reminders	`next_set_token`	N/A
Databases (records)	`start_token`	N/A
Functions	`next_token`	`sync_token`
Widgets	`next_token`	`sync_token`
Slash Commands	`next_token`	`sync_token`
Message Actions	`next_token`	`sync_token`
Schedulers	`next_token`	N/A
Calls & Meetings	`next_token`	`sync_token`
Bot Subscribers	`next_token`	`sync_token`
Departments, Users	`next_token`	N/A
Bots / Message Actions (Marketplace)	`page_number`	N/A

💡 Recommendation: For new integrations, use v3 pagination which provides a simpler and consistent model with next_token and sync_token across all modules.