List events for a given record.

get https://example-org.roserocket.com/api/v2/platformModel/events

Query Params

recordId

uuid

required

Record to fetch events for.

boardId

uuid

The board the record belongs to.

objectKey

string

required

The object key of the record.

type

string

Fetches events of this type.

inTypes

array of strings

Fetches events in the list of provided types.

inTypes

notInTypes

array of strings

Excludes events in the list of provided types.

notInTypes

userId

uuid

Only fetches events created by this user.

orderBy

string

The field to order the results by. Default is createdAt.

orderByDirection

string

The direction to order the results by.

limit

integer

0 to 200

The number of results to fetch per page. Default is 200.

offset

integer

The offset to start fetching results from. Default is 0.

bookmark

string

The bookmark (event id) to start fetching results from. If provided, offset and limit will start from the bookmark.

Response

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example-org.roserocket.com/api/v2/platformModel/events \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the found records.