getList environments

Returns resources in the active workspace in ascending ID order. Use size and either before or after for pagination. page.size is the returned count; page.total is the workspace total. Cursors are exclusive and are null for an empty page. There are no additional filters or sort parameters.

Required service-token scope: environments:read. End-user access is checked against workspace policies. Send a Bearer token and the X-Workspace-Id header.

curl --request GET \
  --url 'https://api.test.neobits.ai/logic/v1/environments?size=50&before=SOME_STRING_VALUE&after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'X-Workspace-Id: 019991b1-0000-7000-8000-000000000001'

Request

Headers

  • Authorization•string

    Bearer token authentication using OAuth 2.0 client credentials flow.

  • X-Workspace-Id•string<uuid>

    Active workspace UUID. The authenticated principal must have access to this workspace.

Params (query)

  • size•integer

    Maximum resources to return (1–5,000). Defaults to 50.

  • before•string<uuid>

    Exclusive resource ID cursor. Use page.before from a previous response. Cannot be combined with after.

  • after•string<uuid>

    Exclusive resource ID cursor. Use page.after from a previous response. Cannot be combined with before.

Response

Headers

  • Content-Type•string

    The content type of the response.

Body

  • data•array<object>

    • id•string<uuid>

      Environment identifier.

    • workspaceId•string<uuid>

      Workspace containing this resource.

    • name•string

      Nonempty name without leading or trailing whitespace.

    • description•string

      Description. Use null or an empty string to clear it.

    • color•string

      A six-digit hex color or one of the supported theme colors. If omitted on creation, a random theme color is persisted.

    • createdAt•string<date-time>

      Creation time.

    • updatedAt•string<date-time>

      Last update time.

  • page•object

    • size•integer

      Number of resources returned in this response.

    • total•integer

      Total resources in the active workspace, independent of the cursor.

    • before•string<uuid>

      First returned ID. Use as before to request the preceding page. Null for an empty page.

    • after•string<uuid>

      Last returned ID. Use as after to request the following page. Null for an empty page. A non-null cursor does not guarantee another page exists.