Get Invite URL - Userplane Docs

Get invite URL

curl --request GET \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/invite-url \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "data": {
    "inviteUrl": "<string>",
    "workspaceId": "<string>"
  }
}

GET

public

workspace

{workspaceId}

invite-url

Get invite URL

curl --request GET \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/invite-url \
  --header 'Authorization: Bearer <token>'

{
  "message": "<string>",
  "data": {
    "inviteUrl": "<string>",
    "workspaceId": "<string>"
  }
}

Returns the invite URL for a workspace. Requires the authenticated user to be an active member of the workspace.

Errors

Error code	Status	Description
`WORKSPACE_NOT_FOUND`	404	Workspace does not exist

Retrieve workspace details

List all workspaces you belong to

Authorization

string

header

required

API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers

workspaceId

string

required

Minimum string length: 1

message

string

required

data

object

required

Show child attributes