API reference / Operations by tag

workspaces

Operations tagged workspaces.

3 operations. Base URL https://api.metrixed.com/v1; see authentication, errors and pagination.

Operations

Method	Path	Summary
POST	`/workspaces/signup`	Public: start a workspace signup; mails a verification link (48 h) to the admin portal. 202 whether or not the email already has an account; honeypot, per-IP and per-email limits
GET	`/workspaces/slug-check`	Public: is a workspace address available (reason invalid\|reserved\|taken)
POST	`/workspaces/verify`	Public: verify the signup email: creates the workspace (trial), owner admin, security defaults, portal hosts and subscription, then signs the owner in (session cookie)

`POST /workspaces/signup`

Public: start a workspace signup; mails a verification link (48 h) to the admin portal. 202 whether or not the email already has an account; honeypot, per-IP and per-email limits

Operation postWorkspacesSignup. Auth: none (public endpoint).

Request body (application/json, required): WorkspaceSignup

Field	Type	Flags	Description
`company`	string	required
`name`	string	required	owner name
`email`	string (email)	required
`password`	string	required	12+ characters
`slug`	string	required	workspace address: 3-40 of a-z 0-9 -
`modes`	array of enum: `network`, `program`, `app_attribution`, `media_buying`, `igaming`, `lead_gen`
`data_region`	enum: `us`, `eu`, `in`, `ap`
`sample_data`	boolean
`locale`	string
`website`	string		honeypot: leave empty
`started_at`	integer		ms epoch when the form rendered (browser signups)

Status	Description	Body
202	ok	application/json WorkspaceSignupAccepted
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/workspaces/signup' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"company":"","name":"","email":"user@example.com","password":"","slug":""}'

Example 202 response:

json

{
  "ok": false,
  "email": "",
  "expires_in_hours": 0
}

`GET /workspaces/slug-check`

Public: is a workspace address available (reason invalid|reserved|taken)

Operation getWorkspacesSlugCheck. Auth: none (public endpoint).

Parameter	In	Type	Required	Description
`slug`	query	string	yes

Status	Description	Body
200	ok	application/json WorkspaceSlugCheck
default	error	application/json Error

bash

curl 'https://api.metrixed.com/v1/workspaces/slug-check' \
  -H 'Accept: application/json'

Example 200 response:

json

{
  "slug": "",
  "available": false,
  "reason": ""
}

`POST /workspaces/verify`

Public: verify the signup email: creates the workspace (trial), owner admin, security defaults, portal hosts and subscription, then signs the owner in (session cookie)

Operation postWorkspacesVerify. Auth: none (public endpoint).

Request body (application/json, required): WorkspaceVerify

Field	Type	Flags	Description
`token`	string	required

Status	Description	Body
201	ok	application/json WorkspaceVerified
default	error	application/json Error

bash

curl -X POST 'https://api.metrixed.com/v1/workspaces/verify' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{"token":""}'

Example 201 response:

json

{
  "tenant_id": "",
  "tenant_slug": "",
  "principal_type": "",
  "redirect": ""
}