{"openapi":"3.0.3","info":{"title":"Accounts","version":"0.0.1"},"servers":[{"url":"https://api.contas.rdstationmentoria.com.br/rest"}],"paths":{"/accounts":{"get":{"operationId":"accounts-list","summary":"Listar contas","description":"Retorna as contas (integrações) configuradas.","tags":["Accounts"],"security":[{"Authorization":[]}],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da conta"},"platform":{"type":"string","enum":["rd","rdcrm","exact"],"description":"Plataforma de origem da conta"},"platformId":{"type":"string","description":"Identificador da conta na plataforma de origem"},"description":{"type":"string","nullable":true,"default":null,"description":"Nome da conta na plataforma de origem"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true,"default":null},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true,"default":null},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.640Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.641Z","description":"Data da última atualização"},"workspaceId":{"type":"string","description":"ID do workspace"}},"required":["id","platform","platformId","workspaceId"],"additionalProperties":false}}}}},"default":{"$ref":"#/components/responses/error"}}}},"/accounts/platform:{platform}":{"get":{"operationId":"accounts-get","summary":"Obter conta","description":"Retorna a conta configurada para uma plataforma.","tags":["Accounts"],"security":[{"Authorization":[]}],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","enum":["rd","rdcrm","exact"]},"description":"Plataforma de origem da conta"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da conta"},"platform":{"type":"string","enum":["rd","rdcrm","exact"],"description":"Plataforma de origem da conta"},"platformId":{"type":"string","description":"Identificador da conta na plataforma de origem"},"description":{"type":"string","nullable":true,"default":null,"description":"Nome da conta na plataforma de origem"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true,"default":null},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true,"default":null},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.643Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.643Z","description":"Data da última atualização"},"workspaceId":{"type":"string","description":"ID do workspace"}},"required":["id","platform","platformId","workspaceId"],"additionalProperties":false,"nullable":true}}}},"default":{"$ref":"#/components/responses/error"}}}},"/memberships":{"get":{"operationId":"memberships-workspace-list","summary":"Listar membros","description":"Retorna os membros (usuários) do workspace.","tags":["Memberships"],"security":[{"Authorization":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Termo de pesquisa"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["membership"]},"data":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do membro"},"workspaceId":{"type":"string","description":"Identificador único do workspace"},"userId":{"type":"string","description":"Identificador único do usuário"},"role":{"type":"string","enum":["owner","admin","user"],"description":"Papel (permissões) do membro"},"user":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do usuário"},"name":{"type":"string","description":"Nome completo do usuário"},"email":{"type":"string","format":"email","description":"Endereço de e-mail do usuário"},"phone":{"type":"string","nullable":true,"default":null,"description":"Número de telefone do usuário (opcional)"},"picture":{"type":"object","properties":{"url":{"type":"string","description":"URL do arquivo"},"title":{"type":"string","nullable":true,"default":null,"description":"Título do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave do arquivo no armazenamento"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Imagem prévia do arquivo"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição do arquivo"}},"required":["url"],"additionalProperties":false,"description":"Imagem de perfil do usuário","nullable":true,"default":null},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.645Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.645Z","description":"Data da última atualização"}},"required":["id","name","email"],"additionalProperties":false,"description":"Dados do usuário"}},"required":["id","workspaceId","userId","role","user"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["invite"]},"data":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do convite"},"email":{"type":"string","format":"email","description":"E-mail do convidado"},"roles":{"type":"array","items":{"type":"object","properties":{"appId":{"type":"string","description":"ID da aplicação à qual o papel se aplica"},"role":{"type":"string","nullable":true,"description":"Papel (permissões) do usuário"}},"required":["appId","role"],"additionalProperties":false}},"admin":{"type":"boolean","description":"Indica se o usuário convidado será um administrador"},"workspaceId":{"type":"string","description":"ID do workspace"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true,"default":null},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true,"default":null},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.646Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.646Z","description":"Data da última atualização"}},"required":["id","email","roles","admin","workspaceId"],"additionalProperties":false}},"required":["type","data"],"additionalProperties":false}],"description":"Representa um membro do workspace"},"description":"Lista de membros do workspace"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/memberships/{id}":{"delete":{"operationId":"memberships-workspace-remove","summary":"Remover membro","description":"Remove um membro do workspace.","tags":["Memberships"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do membro"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}},"/memberships/invite":{"delete":{"operationId":"invites-workspace-cancel","summary":"Cancelar convite","description":"Cancela um convite.","tags":["Memberships"],"security":[{"Authorization":[]}],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"description":"Identificador único do convite"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}},"post":{"operationId":"invites-workspace-send","summary":"Enviar convite","description":"Envia um convite a um usuário por e-mail.","tags":["Memberships"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email","description":"Endereço de e-mail válido"},"minItems":1,"description":"Lista de e-mails únicos para os quais serão enviados convites"},"roles":{"type":"array","items":{"type":"object","properties":{"appId":{"type":"string","description":"Identificador único do app"},"role":{"type":"string","nullable":true,"default":null,"description":"Permissão associada ao membro"}},"required":["appId"],"additionalProperties":false},"description":"Lista de papéis que serão atribuídos aos convidados"},"admin":{"type":"boolean","description":"Indica se o convite é para um administrador"}},"required":["emails","roles","admin"],"additionalProperties":false}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"boolean"}}}},"default":{"$ref":"#/components/responses/error"}}}},"/roles/{membershipId}":{"get":{"operationId":"roles-list","summary":"Listar permissões","description":"Retorna as permissões de um membro (usuário).","tags":["Roles"],"security":[{"Authorization":[]}],"parameters":[{"name":"membershipId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do membro"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"appId":{"type":"string","description":"Identificador único do app"},"role":{"type":"string","nullable":true,"default":null,"description":"Permissão associada ao membro"}},"required":["appId"],"additionalProperties":false},"description":"Lista de papéis com aplicação e nome do papel"}}}},"default":{"$ref":"#/components/responses/error"}}},"put":{"operationId":"roles-update","summary":"Atualizar permissões","description":"Atualiza as permissões de um membro (usuário).","tags":["Roles"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"object","properties":{"appId":{"type":"string","description":"Identificador único do app"},"role":{"type":"string","nullable":true,"default":null,"description":"Permissão associada ao membro"}},"required":["appId"],"additionalProperties":false},"description":"Lista dos papéis"}},"required":["roles"],"additionalProperties":false}}}},"parameters":[{"name":"membershipId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do membro"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"membershipId":{"type":"string","description":"Identificador único do membro"},"appId":{"type":"string","description":"Identificador único do app"},"role":{"type":"string","nullable":true,"default":null,"description":"Permissão associada ao membro"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true,"default":null},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true,"default":null},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.649Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.649Z","description":"Data da última atualização"}},"required":["membershipId","appId"],"additionalProperties":false}}}}},"default":{"$ref":"#/components/responses/error"}}}},"/roles/{membershipId}/{appId}":{"get":{"operationId":"roles-get","summary":"Obter permissões","description":"Retorna as permissões de um membro (usuário) para um aplicativo da plataforma.","tags":["Roles"],"security":[{"Authorization":[]}],"parameters":[{"name":"appId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do app"},{"name":"membershipId","in":"path","required":true,"schema":{"type":"string"},"description":"Identificador único do membro"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"membershipId":{"type":"string","description":"Identificador único do membro"},"appId":{"type":"string","description":"Identificador único do app"},"role":{"type":"string","nullable":true,"default":null,"description":"Permissão associada ao membro"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true,"default":null},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true,"default":null},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.648Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.648Z","description":"Data da última atualização"}},"required":["membershipId","appId"],"additionalProperties":false,"nullable":true}}}},"default":{"$ref":"#/components/responses/error"}}}},"/workspaces/current":{"get":{"operationId":"workspaces-current","summary":"Obter workspace","description":"Retorna detalhes do workspace.","tags":["Workspaces"],"security":[{"Authorization":[]}],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único do workspace"},"type":{"type":"string","enum":["legal_entity","individual"],"description":"Tipo de workspace: pessoa jurídica ou física"},"name":{"type":"string","description":"Nome do workspace"},"picture":{"type":"object","properties":{"url":{"type":"string","description":"URL do arquivo"},"title":{"type":"string","nullable":true,"default":null,"description":"Título do arquivo"},"size":{"type":"number","nullable":true,"default":null,"description":"Tamanho do arquivo em bytes"},"key":{"type":"string","nullable":true,"default":null,"description":"Chave do arquivo no armazenamento"},"ext":{"type":"string","nullable":true,"default":null,"description":"Extensão do arquivo"},"img":{"type":"string","nullable":true,"default":null,"description":"Imagem prévia do arquivo"},"description":{"type":"string","nullable":true,"default":null,"description":"Descrição do arquivo"}},"required":["url"],"additionalProperties":false,"description":"Imagem do workspace (opcional)","nullable":true,"default":null},"site":{"type":"string","nullable":true,"default":null,"description":"Site do workspace (opcional)"},"createdBy":{"type":"string","description":"ID do usuário que criou o registro","nullable":true,"default":null},"updatedBy":{"type":"string","description":"ID do usuário que atualizou o registro","nullable":true,"default":null},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.650Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.650Z","description":"Data da última atualização"}},"required":["id","type","name"],"additionalProperties":false,"nullable":true}}}},"default":{"$ref":"#/components/responses/error"}}},"put":{"operationId":"workspaces-update","summary":"Atualizar workspace","description":"Atualiza informações do workspace.","tags":["Workspaces"],"security":[{"Authorization":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Nome do workspace"}},"required":["name"],"additionalProperties":false}}}},"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{}}}},"default":{"$ref":"#/components/responses/error"}}}},"/subscriptions/current":{"get":{"operationId":"subscriptions-current","summary":"Obter assinatura","description":"Retorna detalhes sobre a assinatura em vigor.","tags":["Subscriptions"],"security":[{"Authorization":[]}],"parameters":[{"name":"appId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"anyOf":[{"not":{}},{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da assinatura"},"status":{"type":"string","enum":["trial","active","canceled","ended"],"description":"Status da assinatura"},"appId":{"type":"string","description":"Identificador da aplicação vinculada"},"priceId":{"type":"string","description":"Identificador do preço contratado"},"coupon":{"type":"string","nullable":true,"default":null,"description":"Cupom aplicado na assinatura"},"source":{"type":"string","enum":["self_service","third_party"],"description":"Origem da assinatura","default":"third_party"},"workspaceId":{"type":"string","description":"ID do workspace"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.651Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.651Z","description":"Data da última atualização"}},"required":["id","status","appId","priceId","workspaceId"],"additionalProperties":false,"nullable":true}]}}}},"default":{"$ref":"#/components/responses/error"}}}},"/subscriptions":{"get":{"operationId":"subscriptions-list","summary":"Listar assinaturas","description":"Lista todas as assinaturas do workspace atual.","tags":["Subscriptions"],"security":[{"Authorization":[]}],"parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único da assinatura"},"status":{"type":"string","enum":["trial","active","canceled","ended"],"description":"Status da assinatura"},"appId":{"type":"string","description":"Identificador da aplicação vinculada"},"priceId":{"type":"string","description":"Identificador do preço contratado"},"coupon":{"type":"string","nullable":true,"default":null,"description":"Cupom aplicado na assinatura"},"source":{"type":"string","enum":["self_service","third_party"],"description":"Origem da assinatura","default":"third_party"},"workspaceId":{"type":"string","description":"ID do workspace"},"createdAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.660Z","description":"Data de criação"},"updatedAt":{"type":"string","format":"date-time","default":"2026-08-30T22:47:07.660Z","description":"Data da última atualização"}},"required":["id","status","appId","priceId","workspaceId"],"additionalProperties":false}}}}},"default":{"$ref":"#/components/responses/error"}}}}},"components":{"securitySchemes":{"Authorization":{"type":"http","scheme":"bearer"}},"responses":{"error":{"description":"Error response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"issues":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}},"required":["message","code"],"additionalProperties":false}}}}}}}