InvitationCode

An invitation code: each use sends one invite to register a new tenant, or registers one, until it runs out.

Kind: an object, used in responses.

Fields

Every field is present in a response; empty ones are null.

Field	Type	Description
code	string	The code itself.
countOriginal	integer	How many invites the code allowed when it was issued.
countRemaining	integer	How many invites it still allows.
userCreatedById	uuid	The id of the user who created it. A call made with an API key is recorded as the key’s user.
tenantId	uuid	The id of the tenant it belongs to.
id	uuid	The unique id. Use it in by-id routes and wherever another object refers to this one.
dateCreated	datetime	When it was created, in UTC.
dateUpdated	datetime	When it was last changed, in UTC.

Example

{
  "code": "...",
  "countOriginal": 0,
  "countRemaining": 0,
  "userCreatedById": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "tenantId": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "id": "3f2b8c1e-5d4a-4e6b-9c7d-2a1b0c9d8e7f",
  "dateCreated": "2026-10-26T12:00:00.0000000Z",
  "dateUpdated": "2026-10-26T12:00:00.0000000Z"
}