Skip to main content
GET
Get a workspace by ID

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

workspaceId
string<uuid>
required

Identifier of the resource in Payrails.

Response

Success.

id
string<uuid>
required

Unique identifier of the Workspace.

name
string
required

Unique name of the Workspace configuration.

createdAt
string<date-time>
required

Date of creation of the workspace configuration.

updatedAt
string<date-time>
required

Date of last update of the workspace configuration.

createdBy
string

Email address of the user that created the workspace.

updatedBy
string

Email address of the user that updated the workspace.

Last modified on October 7, 2026