external_workspaces

Creates, updates, deletes, gets or lists an external_workspaces resource.

Overview

Name	external_workspaces
Type	Resource
Id	railway.workspaces.external_workspaces

Fields

The following fields are returned by SELECT queries:

list

One row per ExternalWorkspace.

Name	Datatype	Description
id	string
name	string
customer_id	string
team_id	string
avatar	string
ban_reason	string
created_at	string (date-time)
current_session_has_access	boolean
customer_state	string	(ACTIVE, CANCELLED, INACTIVE, PAST_DUE, UNPAID)
discord_role	string
has2fa_enforcement	boolean
has_automatic_diagnosis	boolean
has_guardrails_access	boolean
has_saml	boolean
is_trialing	boolean
plan	string	(FREE, HOBBY, PRO)
preferred_region	string
projects	array	List of Project objects
redacted_due_to2fa_pending	boolean
subscription_plan_limit	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select		project_id	Get the workspaces the user doesn't belong to, but needs access (like when invited to a project). Backed by the Railway GraphQL query externalWorkspaces.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
project_id	string

SELECT examples

list

Get the workspaces the user doesn't belong to, but needs access (like when invited to a project). Backed by the Railway GraphQL query externalWorkspaces.

SELECT
id,
name,
customer_id,
team_id,
avatar,
ban_reason,
created_at,
current_session_has_access,
customer_state,
discord_role,
has2fa_enforcement,
has_automatic_diagnosis,
has_guardrails_access,
has_saml,
is_trialing,
plan,
preferred_region,
projects,
redacted_due_to2fa_pending,
subscription_plan_limit
FROM railway.workspaces.external_workspaces
WHERE project_id = '{{ project_id }}'
;