Skip to main content
Whether you are using Retrac’s API or not, this page is a quick way to understand how Retrac works. Within Retrac, all data belongs to a Workspace. Within a workspace, you have Items, Tags, and more.

​
Workspaces

Workspaces is the defacto way of organizing your items and working with your team on Retrac. You can think of a Retrac workspace like a workspace on Slack or Discord – it’s a shared space where you can invite your team members to collaborate on items. When interacting with Retrac’s API, you will also need to specify the Workspace ID to perform any operation. You can find the workspace ID under the General settings page of your 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.
The logo of the workspace.
​
usage
number
required
The transfers 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.
​
storagesLimit
number
required
The storage units limit of the workspace.
​
tagsLimit
number
required
The tags limit of the workspace.
​
usersLimit
number
required
The users limit of the workspace.
​
plan
string
required
The plan of the workspace.
​
stripeId
string | null
required
The Stripe ID of the workspace.
​
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.
​
users
object[]
required
The role of the authenticated user in the workspace.

​
Items

Items are the bread and butter of Retrac. You can shorten any URL to a Retrac item, which you can then share with your audience. Items can be created, updated, and deleted via the Retrac API or the Retrac dashboard.
​
id
string
required
The unique ID of the item.
​
sku
string
required
The code/SKU of the item.
​
description
string
required
The description of the item.
​
quantity
number
required
The quantity of the item.
​
cost
number
required
The cost of the item.
​
tagId
string | null
required
The unique ID of the tag assigned to the item. This field is deprecated – use tags instead.
​
tags
object[] | null
required
The tags assigned to the item.
​
userId
string
required
The user ID of the creator of the item.
​
workspaceId
string
required
The workspace ID of the item.
​
createdAt
string
required
The date and time when the item was created.
​
updatedAt
string
required
The date and time when the item was last updated.
​
projectId
string
required
The project ID of the item. This field is deprecated – use workspaceId instead.

​
Tags

Tags are a way to organize your items. You can add tags to your items to categorize them and make them easier to find.
​
id
string
required
The unique ID of the tag.
​
name
string
required
The name of the tag.
​
color
string
required
The color of the tag.