> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # Links de cadastro > Os links do club, ligados e desligados. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/registration-links openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: students - name: auth paths: /v1/clubs/{clubId}/registration-links: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - students summary: Links de cadastro do club operationId: listRegistrationLinks responses: '200': description: Os links, inclusive desligados content: application/json: schema: $ref: '#/components/schemas/RegistrationLinkList' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > Id público da organização — o mesmo que `GET /v1/me` devolve em `organization_id`. Na URL o recurso se chama **club**; no contrato e no domínio, organization. A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o que as pessoas leem. É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer. O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso. schema: type: string format: uuid schemas: RegistrationLinkList: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/RegistrationLink' RegistrationLink: type: object required: - id - name - code - url - active - available - registrations_count - deliveries - created_at properties: id: type: string format: uuid name: type: string code: type: string url: type: string format: uri description: O endereço público, no classroom do club. active: type: boolean description: Ligado por quem administra. available: type: boolean description: Vale agora — ligado, dentro do prazo e com vaga. registrations_count: type: integer description: Quantas contas nasceram por este link. Só conta nova consome vaga. max_registrations: type: integer description: Vagas. Ausente é sem limite. valid_until: type: string format: date-time description: Até quando o link vale. Ausente é sem prazo. deliveries: type: array items: $ref: '#/components/schemas/RegistrationLinkDelivery' created_at: type: string format: date-time ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string RegistrationLinkDelivery: type: object required: - delivery_id properties: delivery_id: type: string format: uuid delivery_name: type: string readOnly: true cohort_id: type: string format: uuid description: A turma fixada; ausente é a que estiver matriculando. cohort_name: type: string readOnly: true responses: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | Token OPACO de sessão de quem administra, emitido por `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo desenho do `studentSession`, para a outra identidade. É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o `studentSession`; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe. O dashboard o guarda em cookie httpOnly, que o BFF troca pelo `Authorization` a cada chamada. ```` ## Related topics - [Cadastro por link](/api-reference/auth/register-by-link.md) - [Alterar link de cadastro](/api-reference/registration-links/update.md) - [Criar link de cadastro](/api-reference/registration-links/create.md) - [Vitrine do link de cadastro](/api-reference/auth/registration-link.md) - [Configurações do club](/api-reference/clubs/settings-get.md)