Get Invite URL

Retrieve the invite URL for a workspace

GET /public/workspace/{workspaceId}/invite-url

Get invite URL

cURL

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

200

{
  "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

Also returns common authentication errors.

Related

Get Workspace

Retrieve workspace details

List Workspaces

List all workspaces you belong to

Authorizations

Authorization · string · header · required

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

Path Parameters

workspaceId · string · required

Minimum string length: 1

Response

200

application/json

OK

message · string · required

data · object · required

Show child attributes