Workspace and token

← Workspace APIs

GET /whoami

Returns the integration and workspace a token belongs to, and when the token expires. Call it to check that a new token works before you build against the API.

{
  "data": {
    "integration": { "id": 12, "name": "Example data warehouse" },
    "workspace": { "id": "8d6f1c2e-…", "code": "example" },
    "token_expires_at": "2027-11-06T10:15:00Z"
  }
}

Field	Type	Meaning
integration.id	integer	The integration's id in Engagifii.
integration.name	string	The integration's name.
workspace.id	UUID	The workspace this token reads.
workspace.code	string	The workspace's short code.
token_expires_at	date-time or null	When the token stops working. null means it does not expire.

GET /workspace

Workspace settings that change how Engagifii computes its figures. Read them if you want to reproduce Engagifii's reports from the raw data.

{
  "data": {
    "id": "8d6f1c2e-…",
    "timezone": { "name": "Eastern Standard Time", "iana": "America/New_York" },
    "currency": "USD",
    "training_credit_rule": "highest"
  }
}

Field	Type	Meaning
id	UUID	The workspace id. Same as workspace.id from /whoami.
timezone	object or null	The workspace's time zone. Engagifii's money reports (aged receivables, credit-note balances, booked revenue) count days in this time zone, so "as of 31 March" means the end of 31 March here, not in UTC. null if the workspace has none set.
timezone.name	string	The time zone as stored in Engagifii, for example Eastern Standard Time.
timezone.iana	string or null	The matching IANA name, for example America/New_York. null for a time zone outside the US list Engagifii maps.
currency	string	Always USD.
training_credit_rule	string	How a person's training credits are totalled. See below.

training_credit_rule values

For each person, course and credit type, Engagifii counts:

Value	What is counted
first	The first credit earned. This is the default when the workspace has no setting.
highest	The highest credit.
latest	The most recent credit.
every_credit	Every credit earned.

See /training-credits and /course-credits.