API Documentation
Message Queue Docs
Search…
v4
Introduction
Overview
Getting started
🔑
Authentication
Requesting temporary credentials
Signing requests
🎬
Entities
Char types
The entity object
Amount
Catalog item
Contact
Deal
File
Financial document
Inventory
Project
Job
Right
Table
👬
Relationships
The relationship object
Relationship types
Create a relationship
Delete a relationship
🔎
Search
Entity search
Relationship search
Pagination
Making paginated search requests
Sorting search responses
Search fields
Search functions
Examples
🆕Batch
Overview
Create a batch
Retrieve a batch
🧰
Workflow
Execute a workflow action
Execute document workflow action
Execute a workflow action with signature
📐Configuration
Lists
Currency conversion
Data Types
📆
Date Math
Overview
The date math object
Create date math
Retrieve date math
Update date math
Delete date math
🧮
AVAILS
Overview
Get dimension data
Get availability
Get available catalog items
Is catalog item available
🧑
Users
Get Applications
Get Roles
Create a user
⌨
SSO
SSO Endpoints
⌨
Starter Packs
Catalog Metadata
Availability Feed
Swagger
Postman
Message queue docs
Rightsline.com
Powered By GitBook
Pagination
Search requests return paginated results.
The API "search" endpoints return a result set of objects matching the parameters of the search request. Rightsline utilizes offset pagination to dictate the number of objects returned in each request. Pagination is controlled using the following two request parameters: start, rows.

Parameters

Parameter
Type
Default
Description
start
int
0
The zero-based index offset of the first object in the result set.
rows
int
100
The number of objects to return in the result set.

Example: Search for catalog items with a template ID = 1 (paginated)

{
"query": {
"$and": [
{
"$eq": [
"templateid",
1
]
}
]
},
"start": 0,
"rows": 100
}
Search - Previous
Relationship search
Next
Making paginated search requests
Last modified 2yr ago
Copy link
On this page
Parameters