Get an environment | Neobits API Documentation

getGet an environment

Retrieves one environment in the active workspace. Returns 404 when it is not found in that workspace.

Required service-token scope: environment: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/019991b1-0000-7000-8000-000000000002 \
  --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.
Required
X-Workspace-Id•string<uuid>
Active workspace UUID. The authenticated principal must have access to this workspace.
Required

Params (path)

id•string<uuid>
Environment identifier.
Required

Response

Headers

Content-Type•string
The content type of the response.

Body

id•string<uuid>
Environment identifier.
Required
workspaceId•string<uuid>
Workspace containing this resource.
Required
name•string
Nonempty name without leading or trailing whitespace.
Required
description•string
Description. Use null or an empty string to clear it.
RequiredNullable
color•string
A six-digit hex color or one of the supported theme colors. If omitted on creation, a random theme color is persisted.
Required
createdAt•string<date-time>
Creation time.
Required
updatedAt•string<date-time>
Last update time.
Required