Skip to main content
GET
Retrieve a workspace

Authorizations

Authorization
string
header
required

Bearer API key from Settings → API Keys. Use restricted keys (prefix retrac_) with the minimum scopes required.

Path Parameters

idOrSlug
string
required

The ID or slug of the workspace.

Response

The retrieved workspace

id
string
required

The unique ID of the workspace.

name
string
required

The name of the workspace.

slug
string
required

The slug of the workspace.

logo
string | null
required

The logo of the workspace.

usage
number
required

The usage of the workspace.

usageLimit
number
required

The usage limit of the workspace.

itemsUsage
number
required

The items usage of the workspace.

itemsLimit
number
required

The items limit of the workspace.

billingDocumentsUsage
number
required

Lifetime invoices + estimates created on this workspace.

billingDocumentsLimit
number
required

Max billing documents allowed (Free plan quota).

suppliersUsage
number
required

The suppliers usage of the workspace.

suppliersLimit
number
required

The suppliers limit of the workspace.

locationsUsage
number
required

The locations usage of the workspace.

locationsLimit
number
required

The locations limit of the workspace.

defaultLocationId
string | null
required

The ID of the default 'Inventory' location.

defaultCurrency
string
required

Default currency for jobs and monetary displays.

Required string length: 3
invoiceNumberPrefix
enum<string>
required

Fixed prefix used when generating invoice numbers.

Available options:
INV
defaultTaxPercent
number
required

Default tax rate applied when closing jobs.

Required range: 0 <= x <= 100
defaultTaxIncluded
boolean
required

When true, line prices include tax; when false, tax is added on top.

defaultInvoiceDueDays
integer
required

Days after creation when new invoices are due by default (0 = no default due date).

Required range: 0 <= x <= 365
defaultInvoiceNote
string | null
required

Default note/payment terms pre-filled on new invoices.

defaultEstimateNote
string | null
required

Default note/payment terms pre-filled on new estimates.

invoicingBusinessName
string | null
required

Business name shown on invoices and estimates.

invoicingBrandColor
string | null
required

Accent color used on client-facing billing documents.

invoicingEmail
string | null
required

Contact email shown on billing documents.

invoicingPhone
string | null
required

Contact phone shown on billing documents.

invoicingAddress
string | null
required

Business address shown on billing documents.

invoicingWebsite
string | null
required

Website shown on billing documents.

invoicingLogoUrl
string | null
required

Custom logo URL for invoices and estimates (overrides workspace logo).

invoicingPdfTemplate
enum<string>
default:classic
required

PDF layout for invoices and estimates.

Available options:
classic,
modern,
minimal,
impact,
elegant,
showcase
defaultInvoiceSourceLocationId
string | null
required

Default source location when closing jobs.

defaultTransferFromLocationId
string | null
required

Default source location when creating transfers.

defaultLocationType
enum<string>
required

Default type for newly created locations.

Available options:
warehouse,
van,
truck,
site,
other
defaultMarkupPercent
number | null
required

Default markup percentage applied from unit cost to sell price.

Required range: 0 <= x <= 1000
tagsLimit
number
required

The tags limit of the workspace.

usersLimit
number
required

The users limit of the workspace.

plan
enum<string>
required

The plan of the workspace.

Available options:
free,
pro,
business,
advanced,
business plus,
business extra,
business max,
enterprise
stripeId
string | null
required

The Stripe ID of the workspace.

appleOriginalTransactionId
string | null
required

The Apple In-App Purchase subscription linked to the workspace, if billing is managed through the App Store.

billingCycleStart
number
required

The date and time when the billing cycle starts for the workspace.

createdAt
string
required

The date and time when the workspace was created.

trialEndsAt
string | null
required

When the workspace billing trial ends, if applicable.

billingCycleEndsAt
string | null
required

When the current billing cycle ends.

subscriptionCanceledAt
string | null
required

When the workspace subscription was canceled.

paymentFailedAt
string | null
required

When the last platform subscription payment failed.

users
object[]
required

The role of the authenticated user in the workspace.

inviteCode
string | null
required

The invite code of the workspace.

ssoEmailDomain
string | null
required
ssoEnforcedAt
string | null
required
paymentReminderEnabled
boolean
required
paymentReminderDaysBefore
integer[] | null
required
paymentReminderOffsets
integer[] | null
required
Maximum array length: 10
Required range: -365 <= x <= 365
emailMessageUseGeneric
boolean
default:true
required
emailMessageDefault
string | null
required
Maximum string length: 5000
emailMessageInvoice
string | null
required
Maximum string length: 5000
emailMessageEstimate
string | null
required
Maximum string length: 5000
emailMessageCc
string<email> | null
required
emailMessageBcc
string<email> | null
required
paymentNoteEnabled
boolean
default:true
required
paymentReceiptEnabled
boolean
default:false
required
taxCountry
string | null
required
taxRegistrationNumber
string | null
required
taxYearStartMonth
integer
default:1
required
Required range: 1 <= x <= 12
taxYearStartDay
integer
default:1
required
Required range: 1 <= x <= 31
withholdingTaxEnabled
boolean
default:false
required
withholdingTaxLabel
string | null
default:Withholding Tax
required
withholdingTaxPercent
number | null
required
Required range: 0 <= x <= 100
taxes
object[]
required

Named tax rates configured under Tax settings & currency.

clientFollowUpEnabled
boolean
default:false
required
clientFollowUpDefaultMonths
integer
default:6
required
clientFollowUpDefaultOnInvoice
boolean
default:false
required
clientFollowUpSubject
string | null
required
clientFollowUpBody
string | null
required
shiftLiveLocationEnabled
boolean
default:true
required

Whether live location pings are recorded during active shifts.

estimateNumberPrefix
enum<string>
default:EST
required

Fixed prefix used when generating estimate numbers.

Available options:
EST
autoServiceCallLineEnabled
boolean
default:false
required

Whether new invoices/estimates get a default service-call line.

deductInventoryOnInvoice
boolean
default:true
required

Whether sending an invoice deducts catalog item stock from the source location.

defaultLowStockThreshold
integer
default:5
required

Default low-stock threshold for items without an override. 0 means only exact zero is treated as out of stock.

Required range: x >= 0
stockDigestEnabled
boolean
default:false
required

Whether to send a weekly stock-health digest to owners/admins with inventory alerts on.

serviceCallLabel
string | null
required

Label for the default service-call line item.

serviceCallPriceCents
integer | null
required

Unit price in cents for the default service-call line.

serviceCallQuantity
integer
default:1
required

Quantity for the default service-call line.

defaultDepositPercent
number | null
required

Default deposit percent suggested on invoices.

invoicingOnlinePaymentsEnabled
boolean
default:false
required

Whether online payment collection is enabled for invoices.

stripeConnectChargesEnabled
boolean
default:false
required

Whether Stripe Connect is ready to accept charges.

locationAccess
object

Location access for the authenticated member.

memberPermissions
object

Effective member capabilities for the authenticated user.

impersonation
object

Present when the workspace owner is temporarily viewing as another member.