Entities Structure

Get Universes

List the available universes

GET
https://api.textreveal.com/v3/universes

Request

Parameters

  • sizeinteger

    Number of records per page

    Default: 10Range: [1, 1000]
  • search_afteruuid

    The last ID on the page you're currently on when you want to fetch the next page.

Response

Response - 200

Properties of the universes

  • data*object[]

    Properties of the universes. Only the universes available for your company are returned.

  • size*integer

    Number of records per page requested.

    Example: 1
  • has_next*boolean

    True if there are more records available.

    Example: true
  • count*integer

    Number of records returned in the current page.

    Example: 1
  • search_after*string | null

    Cursor for next page.

Response
{
  "data": [
    {
      "universe_name": "string",
      "universe_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "size": 1,
  "has_next": true,
  "count": 1,
  "search_after": "string"
}