Data Item

Get All Data Items

This endpoint returns all data items within a collection that the user has access to. The results will be paginated. If the number of data items exceeds the pagination limit, links will be provided to get the next set of results or the previous set of results (if applicable). The range of returned values can be determined by optional start and end parameters. If the difference between the end and start values is greater than the pagination limit, the endpoint returns collections in the range from start to start + pagination limit. Items in the response are determined based on their creation order.

This endpoint also supports an optional filter string that can be used to filter down the data items returned based off the items' fields' values. If a filter is included, the start and end parameters only refer to items which satisfy the filter; this is also true of the total value in the response. For more details, see Data Item Filters.

get/collections/{collectionId}/items

Request

  • Base URL
    https://data.lucid.app
  • URL
    https://data.lucid.app/collections/{collectionId}/items
  • Auth
    OAuth 2
    Authorization code: https://lucid.app/oauth2/authorize
    Token URL: https://api.lucid.co/oauth2/token scopes: data-service.admin

Path parameters

collectionIdinteger required

ID of collection to get data items from

Query parameters

startinteger
Example:1

Starting 1-based index of the data items to return. Defaults to 1.

endinteger
Example:100

Ending 1-based index of the data items to return. Defaults to 10000.

filterstring
Example:filter=age%20%3E%2016

URL encoded filter string. Example unencoded is filter=age > 16

Response

OK with paginated list of Data Items

totalinteger

Total number of data items in the collection

prevstring

Link to get the previous set of data items

nextstring

Link to get the next set of data items

Example response

{
  "items": [
    {
      "uri": "https://data.lucid.app/collections/2/items/4",
      "collection": "https://data.lucid.app/collections/2",
      "fields": {
        "Co1B": "value1",
        "Co2B": "value2"
      }
    }
  ],
  "total": 175,
  "prev": "https://data.lucid.app/collections/2/items?start=1&end=100",
  "next": "https://data.lucid.app/collections/2/items?start=201&end=300"
}

Changes

No recorded changes to this operation across all 1 revision of this API.