Skip to content

Workspaces API

Workspace endpoints gestionan workspaces, miembros y workspace avatar.

GET /api/v2/workspaces

Devuelve la lista de workspaces disponibles para el account actual.

Argumentos: ninguno.

Payload: ninguno.

Respuesta: WorkspaceViewShort[].

GET /api/v2/workspaces/:fullname

Devuelve un workspace.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathWorkspace fullname.

Payload: ninguno.

Respuesta: WorkspaceView.

PUT /api/v2/workspaces/:fullname

Crea un nuevo workspace o actualiza uno existente.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathWorkspace fullname. Debe coincidir con payload.fullname.

Payload:

CampoObligatorioDescripción
fullnameWorkspace fullname.
createOnlyNoSi true, endpoint devuelve error si workspace ya existe.
resetInviteNoRegenera invite state.
tagsNoArray de tags.
labelsNoObjeto con labels string.
meta.titleNoTítulo visible del workspace.
meta.avatarNoAvatar URL.

Respuesta: WorkspaceView.

DELETE /api/v2/workspaces/:fullname

Elimina workspace.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathWorkspace fullname.

Payload: ninguno.

Respuesta: OperationResult.

POST /api/v2/workspaces/:fullname/avatar

Sube el avatar del workspace.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathWorkspace fullname.

Payload:

CampoObligatorioDescripción
filenameNombre original del archivo.
contentTypeMIME type de la imagen.
dataDatos de imagen en Base64.

Respuesta: AvatarUploadResult.

GET /api/v2/workspaces/:workspace/acl

Devuelve lista de members/ACL entries del workspace.

Argumentos:

ArgumentoUbicaciónDescripción
workspacePathWorkspace fullname.

Payload: ninguno.

Respuesta: WorkspaceAclEntry[].

POST /api/v2/workspaces/:workspace/acl

Crea invite o ACL entry.

Argumentos:

ArgumentoUbicaciónDescripción
workspacePathWorkspace fullname.

Payload:

CampoObligatorioDescripción
inviteInvite id/token.

Respuesta: WorkspaceAclEntry.

PUT /api/v2/workspaces/:workspace/acl/:entryId

Cambia el rol de member.

Argumentos:

ArgumentoUbicaciónDescripción
workspacePathWorkspace fullname.
entryIdPathACL entry id.

Payload:

CampoObligatorioDescripción
levelUno de owner, admin, developer, user.

Respuesta: WorkspaceAclEntry.

DELETE /api/v2/workspaces/:workspace/acl/:entryId

Elimina member/ACL entry.

Argumentos:

ArgumentoUbicaciónDescripción
workspacePathWorkspace fullname.
entryIdPathACL entry id.

Payload: ninguno.

Respuesta: OperationResult.