ListQueryParameters interface
Request options for list requests.
Properties
| after | A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list. |
| before | A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. |
| limit | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. |
| order | Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order. |
Property Details
after
A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
after?: stringProperty Value
string
before
A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
before?: stringProperty Value
string
limit
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
limit?: numberProperty Value
number
order
Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.
order?: "asc" | "desc"Property Value
"asc" | "desc"
