Skip to main content
GET
/
api
/
workspace
/
{workspaceId}
/
onboarding-link
Obtener Link de Onboarding
curl --request GET \
  --url https://api.plazbot.com/api/workspace/{workspaceId}/onboarding-link \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.plazbot.com/api/workspace/{workspaceId}/onboarding-link"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.plazbot.com/api/workspace/{workspaceId}/onboarding-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.plazbot.com/api/workspace/{workspaceId}/onboarding-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.plazbot.com/api/workspace/{workspaceId}/onboarding-link"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.plazbot.com/api/workspace/{workspaceId}/onboarding-link")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.plazbot.com/api/workspace/{workspaceId}/onboarding-link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "code": 123,
  "errorCode": "<string>",
  "message": "<string>",
  "data": {
    "id": "<string>",
    "type": "<string>",
    "token": "<string>",
    "shortUrl": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>"
  }
}
{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}
{
"success": true,
"code": 123,
"message": "<string>",
"errorCode": "<string>"
}

Authorizations

Authorization
string
header
required

Token de autenticacion Bearer. Obtenga el token usando el endpoint /api/user/login

Path Parameters

workspaceId
string
required

ID del workspace

Query Parameters

type
enum<string>
required

Tipo de integracion. Valores validos: whatsapp, whatsapp_business, facebook, instagram

Available options:
whatsapp,
whatsapp_business,
facebook,
instagram

Response

Link de onboarding obtenido exitosamente

success
boolean
required

Indica si la operacion fue exitosa

code
integer
required

Codigo HTTP de la respuesta

errorCode
string | null
required

Codigo de error, null si no hay error

message
string
required

Mensaje descriptivo del resultado

data
object | null
required

Datos del link de onboarding