|Authentication||Session authentication , API Token Authentication , Password Authentication|
The user or API Token must have permission to view the records.
|id||String||Yes||The cursor ID.|
|records||Array||An array of objects that includes field data of records that match the query.
The response is the same as the response for the Get Records API.
States whether there are more records that can be acquired from the cursor.
Run this API again with the same parameters to obtain the next set of records.
The cursor will remain valid until all records have been obtained.
The Get Cursor API returns records that match the query at the timing when the Add Cursor API is called. However, the Get Cursor API returns the field values of records at the timing the Get Cursor API is called.
- In the case where new permission settings are applied to the App after a cursor is added, the Get Cursor API may return records that should not match the query with the new permissions. In this case, values within fields with no view permissions cannot be seen in the response.
- As the field values obtained is dependent on when the Get Cursor API is called, the obtained values from localized fields may vary depending on the API initiator's language settings.
- There may be cases when the next set of records obtained (when the next parameter is true) is empty, if records are deleted or have new permissions settings applied during the Get Cursor API requests.
- The cursor will automatically be deleted when it responds false for the next parameter. Any further requests will result in a 404 error response.