me · Delulu Docs

Generated from the typed server contract. Download the complete OpenAPI 3.1 specification.

Get the authenticated user

GET/v1/me

Parameters

No path or query parameters.

Request body

No request body.

Responses

Status	Meaning
`200`	MeResponse
`401`	UnauthorizedError
`402`	QuotaExceededError
`429`	RateLimitedError

Response bodies

`200` — application/json

{
  "$ref": "#/components/schemas/MeResponse"
}

`401` — application/json

{
  "$ref": "#/components/schemas/UnauthorizedError"
}

`402` — application/json

{
  "$ref": "#/components/schemas/QuotaExceededError"
}

`429` — application/json

{
  "$ref": "#/components/schemas/RateLimitedError"
}

Get the workspace command-center overview

GET/v1/me/overview/{workspaceId}

Parameters

Name	In	Required	Type
`workspaceId`	path	yes	string

Request body

No request body.

Responses

Status	Meaning
`200`	WorkspaceOverviewResponse
`401`	UnauthorizedError
`402`	QuotaExceededError
`403`	ForbiddenError
`404`	NotFoundError
`429`	RateLimitedError

Response bodies

`200` — application/json

{
  "$ref": "#/components/schemas/WorkspaceOverviewResponse"
}

`401` — application/json

{
  "$ref": "#/components/schemas/UnauthorizedError"
}

`402` — application/json

{
  "$ref": "#/components/schemas/QuotaExceededError"
}

`403` — application/json

{
  "$ref": "#/components/schemas/ForbiddenError"
}

`404` — application/json

{
  "$ref": "#/components/schemas/NotFoundError"
}

`429` — application/json

{
  "$ref": "#/components/schemas/RateLimitedError"
}

me.setup

GET/v1/me/setup/{workspaceId}

Parameters

Name	In	Required	Type
`workspaceId`	path	yes	string

Request body

No request body.

Responses

Status	Meaning
`200`	Success
`401`	UnauthorizedError
`402`	QuotaExceededError
`403`	ForbiddenError
`404`	NotFoundError
`429`	RateLimitedError

Response bodies

`200` — application/json

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string"
    },
    "connectedPlatforms": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "subscription": {
      "type": "object",
      "properties": {
        "plan": {
          "type": "string"
        },
        "status": {
          "type": "string"
        },
        "paid": {
          "type": "boolean"
        }
      },
      "required": [
        "plan",
        "status",
        "paid"
      ],
      "additionalProperties": false
    },
    "optionalSteps": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "outstandingAction": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "connect_account",
            "complete_payment"
          ]
        },
        {
          "type": "null"
        }
      ]
    },
    "onboardingComplete": {
      "type": "boolean"
    }
  },
  "required": [
    "workspaceId",
    "connectedPlatforms",
    "subscription",
    "optionalSteps",
    "outstandingAction",
    "onboardingComplete"
  ],
  "additionalProperties": false
}

`401` — application/json

{
  "$ref": "#/components/schemas/UnauthorizedError"
}

`402` — application/json

{
  "$ref": "#/components/schemas/QuotaExceededError"
}

`403` — application/json

{
  "$ref": "#/components/schemas/ForbiddenError"
}

`404` — application/json

{
  "$ref": "#/components/schemas/NotFoundError"
}

`429` — application/json

{
  "$ref": "#/components/schemas/RateLimitedError"
}

me.update Setup

PATCH/v1/me/setup/{workspaceId}

Parameters

Name	In	Required	Type
`workspaceId`	path	yes	string

Request body

Required.

application/json

{
  "type": "object",
  "properties": {
    "optionalSteps": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "enum": [
          "completed",
          "skipped"
        ]
      }
    }
  },
  "required": [
    "optionalSteps"
  ],
  "additionalProperties": false
}

Responses

Status	Meaning
`200`	Success
`401`	UnauthorizedError
`402`	QuotaExceededError
`403`	ForbiddenError
`404`	NotFoundError
`429`	RateLimitedError

Response bodies

`200` — application/json

{
  "type": "object",
  "properties": {
    "updated": {
      "type": "boolean"
    }
  },
  "required": [
    "updated"
  ],
  "additionalProperties": false
}

`401` — application/json

{
  "$ref": "#/components/schemas/UnauthorizedError"
}

`402` — application/json

{
  "$ref": "#/components/schemas/QuotaExceededError"
}

`403` — application/json

{
  "$ref": "#/components/schemas/ForbiddenError"
}

`404` — application/json

{
  "$ref": "#/components/schemas/NotFoundError"
}

`429` — application/json

{
  "$ref": "#/components/schemas/RateLimitedError"
}

me.email Preferences

GET/v1/me/email-preferences

Parameters

No path or query parameters.

Request body

No request body.

Responses

Status	Meaning
`200`	Success
`401`	UnauthorizedError
`402`	QuotaExceededError
`429`	RateLimitedError

Response bodies

`200` — application/json

{
  "type": "object",
  "properties": {
    "productLifecycleEnabled": {
      "type": "boolean"
    },
    "marketingEnabled": {
      "type": "boolean"
    }
  },
  "required": [
    "productLifecycleEnabled",
    "marketingEnabled"
  ],
  "additionalProperties": false
}

`401` — application/json

{
  "$ref": "#/components/schemas/UnauthorizedError"
}

`402` — application/json

{
  "$ref": "#/components/schemas/QuotaExceededError"
}

`429` — application/json

{
  "$ref": "#/components/schemas/RateLimitedError"
}

me.update Email Preferences

PUT/v1/me/email-preferences

Parameters

No path or query parameters.

Request body

Required.

application/json

{
  "type": "object",
  "properties": {
    "productLifecycleEnabled": {
      "type": "boolean"
    },
    "marketingEnabled": {
      "type": "boolean"
    }
  },
  "required": [
    "productLifecycleEnabled",
    "marketingEnabled"
  ],
  "additionalProperties": false
}

Responses

Status	Meaning
`200`	Success
`401`	UnauthorizedError
`402`	QuotaExceededError
`429`	RateLimitedError

Response bodies

`200` — application/json

{
  "type": "object",
  "properties": {
    "productLifecycleEnabled": {
      "type": "boolean"
    },
    "marketingEnabled": {
      "type": "boolean"
    }
  },
  "required": [
    "productLifecycleEnabled",
    "marketingEnabled"
  ],
  "additionalProperties": false
}

`401` — application/json

{
  "$ref": "#/components/schemas/UnauthorizedError"
}

`402` — application/json

{
  "$ref": "#/components/schemas/QuotaExceededError"
}

`429` — application/json

{
  "$ref": "#/components/schemas/RateLimitedError"
}

List the user’s workspace memberships

GET/v1/me/workspaces

Parameters

No path or query parameters.

Request body

No request body.

Responses

Status	Meaning
`200`	MeWorkspacesResponse
`401`	UnauthorizedError
`402`	QuotaExceededError
`429`	RateLimitedError

Response bodies

`200` — application/json

{
  "$ref": "#/components/schemas/MeWorkspacesResponse"
}

`401` — application/json

{
  "$ref": "#/components/schemas/UnauthorizedError"
}

`402` — application/json

{
  "$ref": "#/components/schemas/QuotaExceededError"
}

`429` — application/json

{
  "$ref": "#/components/schemas/RateLimitedError"
}

me

On this page