Referencia: Workspace

Generada desde el contrato OpenAPI

Esta referencia se genera directamente del contrato de la API, por lo que sus descripciones están en inglés. Puedes descargarlo en openapi.json. Las guías explican cómo usar estos endpoints.

Workspace

Identify the API key in use.

Operaciones

GET/api-key

---

Describe the API key in use

GET

/api-key

Returns the key id, name and scopes, and the workspace it is bound to. Needs no particular scope.

Autorizaciones

bearerAuth

An API key created in the dashboard (Authorization: Bearer ). The scopes listed on each operation must be granted to the key: instances:read, instances:write, messages:read, messages:send, webhooks:read, webhooks:write.

Tipo

HTTP (bearer)

Respuestas

The key and its workspace.

Content-Type

application/json

{

  

"data": {

  

  

"id": "string",

  

  

"name": "string",

  

  

"scopes": [

  

  

  

"string"

  

  

],

  

  

"workspace": {

  

  

  

"id": "string",

  

  

  

"name": "string"

  

  

}

  

}

}

GET

/api-key

Ejemplos

---