universe
GET /data/{collectionName}
Api key auth Bearer auth

This endpoint can be used to list arbitrary object inside a collection.

Path parameters

  • collectionName string Required

    defines the collection on which you want to call the operation (e.g users)

Query parameters

  • sort string

    a parameter used for sort (e.g createdAt or points)

  • sortOrder string

    asc or desc

  • before string

    Use before to query for entries before a given parameter. (e.g before[createdAt]=2023-06-21T12:34:56+00:00)

  • after string

    Use after to query for entries after a given parameter. (e.g after[createdAt]=2023-06-21T12:34:56+00:00)

  • limit integer

    Limits the number of results. (default 50, max 500)

  • filter object

    Use any key value combination to query for properties (e.g name=foo). Additionally you can query with options, like age[string]=42 (forces a string check for age) or age[int:gt]=30 (forces a int check and greater than filter)

    Hide filter attribute Show filter attribute object
    • * string | integer Additional properties
  • existsFilter object

    Use a combination of exists[key]=true or exists[key] = false to check for existance of key on data object

    Hide existsFilter attribute Show existsFilter attribute object
    • * string Additional properties
  • authField string

    this parameter can be used to use a different item field other then the original field (userId). This field is used to map data objects to sub accounts.

Responses

  • 200 application/json

    success

    Hide response attribute Show response attribute object
    • * string | number | boolean | object | array Additional properties
GET /data/{collectionName} 
curl \
 --request GET 'https://api.universecloud.io/data/users' \
 --header "X-Api-Key: $API_KEY"
Response examples (200) 
[
  {
    "_id": "64a1cc789f556f7ce46c576b",
    "age": 30,
    "name": "foo bar",
    "userId": "auth0|63dfc22f977173187654321"
  }
]