The Blink REST API provides programmatic access to Blink data and functionality, enabling the management of resources such as workflows, users, cases, and more.
offset
, limit
, filter
and sort
(all of them are optional).
offset and limit
OFFSET
and LIMIT
in a standard SQL syntax.
limit
must be greater than 0 and less than or equal to 1000offset
must be greater than or equal to 0 and its default value is 0offset and limit
examplesort
([]string)
that is equivalent to the SQL ORDER BY
clause. The default order for a column is ascending order, but you can control the order by using the following prefix: +
or -
. +
means ascending order, and -
means descending order.
sort
exampleupdated_at
column in a Case Management Table in ascending order as there is a +
before the updated_at
field value.
select
([]string)
that is joined with a comma (”,”) to the RQL SELECT
clause.
select
Example:id
, name
, and status
fields for each record from your case management table.
filter
WHERE
clause. The $or
operator is used to combine multiple conditions, requiring that at least one of the specified conditions must be true for a record to match. Its type is an array of condition objects.
filter
Example:field: { <predicate>: <value>, ...}
, For example:AND
operator is used between the two predicates. Its type is an object of conditions.
$eq
: Equals (can be used on all types)$neq
: Not equals (can be used on all types)$gt
: Greater than (can be used on numbers, strings, and timestamp)$lt
: Less than (can be used on numbers, strings, and timestamp)$gte
: Greater than or equal to (can be used on numbers, strings, and timestamp)$lte
: Less than or equal to (can be used on numbers, strings, and timestamp)$like
: Like (can be used only on type string)limit
: Limits the number of records returned
25
: Specifies that the query should return a maximum of 25 records.filter
: The main object containing the filtering criteria.
case_type
:%eq
: Filters records where the “case_type” field is “Cloud Security”.created_at
$gt
: Specifies that the created_at field must be greater than “2018-01-01T16:00:00.000Z”.$lt
: Specifies that the created_at field must be less than “2018-04-01T16:00:00.000Z”.$or
: Logical OR operator to combine multiple conditions.
severity
:
"high"
: Filters records where the severity field is “high”.status
:
"open"
: Filters records where the status field is “open”.sort
: Specifies the sorting order of the returned records.
["-created_at"]
: Sorts the records in descending order by the created_at field (the - sign indicates descending order).filter
: The main object containing the filtering criteria
status
:$eq
: Specifies that the status field must be equal to “open”.priority
:
$gt
: Specifies that the priority field must be greater than 2.case_manager
:
contains_any
: Specifies that the “case_manager” field must contain at least one of the specified values (“johndoe@gmail.com” or “janedoe@gmail.com”).overview
:
$like
: Specifies that the overview field must match the pattern “%urgent%”, meaning it should contain the word “urgent” anywhere within the overview text field.created_at
:
$gte
: Specifies that the “created_at” field must be greater than or equal to “2024-01-01T00:00:00Z”.$lt
: Specifies that the created_at field must be less than “2024-04-31T23:59:59Z”.