Sign in

v1

latestOpenAPI 3.0.02026-07-24115101.2 MB
Workspace

Get a workspace by ID

Use this endpoint to retrieve a specific workspace by ID.

get/workspaces/{workspace_id}

Path parameters

workspace_idinteger required

The unique ID of the workspace.

Headers

x-oneflow-api-tokenstring required

The API key of your Oneflow account.

x-oneflow-user-emailstring email

The email address of a registered Oneflow user.

Response

Returns the requested workspace.

company_namestring

The name of the company.

country_codestring branding_country_code

The default country code used in all templates and contracts that belong to this workspace.

created_timestring datetime nullable

The time when this workspace was created.

date_formatstring

The format of the date used in all templates and contracts that belong to this workspace.

descriptionstring

The description of this workspace.

idinteger required

The unique id of this workspace.

namestring required

The name of this workspace.

registration_numberstring

The registration number of the company.

typestring

The type of the workspace.

updated_timestring datetime nullable required

The time when this workspace was last updated.