{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Gravity Play","description":"Documentação da API da Gravity Play — crie cobranças, leve ao checkout e receba pagamentos por webhook.","colors":{"primary":"#EA580C","light":"#FB923C","dark":"#F97316"},"logo":{"light":"https://mintcdn.com/gravityplay/b7AIIk7hcK-Pou2a/logo/light.png?fit=max\u0026auto=format\u0026n=b7AIIk7hcK-Pou2a\u0026q=85\u0026s=098c877fccb72289c5e070695f803600","dark":"https://mintcdn.com/gravityplay/b7AIIk7hcK-Pou2a/logo/dark.png?fit=max\u0026auto=format\u0026n=b7AIIk7hcK-Pou2a\u0026q=85\u0026s=d2f027b73d5e28ee59c8bfb9bfc135ba"},"favicon":"https://mintcdn.com/gravityplay/b7AIIk7hcK-Pou2a/favicon.png?fit=max\u0026auto=format\u0026n=b7AIIk7hcK-Pou2a\u0026q=85\u0026s=b8e7801bd811dd295a96da4a49e284a4","api":{"playground":{"proxy":true}},"appearance":{"default":"system"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gravityplay","hasAudioNarration":false,"actualSubdomain":"gravityplay","customDomains":["docs.gravitypay.app"],"gitSource":{"type":"github","owner":"leonammoura","repo":"gravity-pay","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"4ee58d31-b89d-4b0b-bad3-430ae590cd5f","liveDeploymentHistoryId":"6ada1e628b3d16364f988a2b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada1e628b3d16364f988a2b"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ada1e628b3d16364f988a2b","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":13},{"language":"default","tag":"Guias","count":12},{"language":"default","tag":"Cobranças","count":4},{"language":"default","tag":"Alunos","count":3},{"language":"default","tag":"Introdução","count":2},{"language":"default","tag":"Cursos","count":2},{"language":"default","tag":"Pagamentos","count":2},{"language":"default","tag":"Assinaturas","count":1},{"language":"default","tag":"Turmas","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/alunos/consultar-aluno","slug":"/api-reference/alunos/consultar-aluno","pageMetadata":{"title":"Consultar aluno","description":"Retorna o aluno com todas as matrículas, no mesmo formato de um item de `GET /v1/students`. Aluno de outra loja ou de pré-visualização responde 404.\n\nEscopo exigido: `students:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/students/{id}","href":"/api-reference/alunos/consultar-aluno","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Retorna o aluno com todas as matrículas, no mesmo formato de um item de \", _jsx(_components.code, {\n children: \"GET /v1/students\"\n }), \". Aluno de outra loja ou de pré-visualização responde 404.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Escopo exigido: \", _jsx(_components.code, {\n children: \"students:read\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Consultar aluno","description":"Retorna o aluno com todas as matrículas, no mesmo formato de um item de `GET /v1/students`. Aluno de outra loja ou de pré-visualização responde 404.\n\nEscopo exigido: `students:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/students/{id}","href":"/api-reference/alunos/consultar-aluno","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Alunos"],"summary":"Consultar aluno","operationId":"getStudent","x-required-scope":"students:read","description":"Retorna o aluno com todas as matrículas, no mesmo formato de um item de `GET /v1/students`. Aluno de outra loja ou de pré-visualização responde 404.\n\nEscopo exigido: `students:read`.","parameters":["0998ee55-b334-4f33-8d56-e4a3d18a165c"],"responses":{"200":"8fe2b228-b264-4d1f-b92a-bac63a341449","401":"b572a019-cdf4-4c6e-b6b5-31e6a029134e","403":"8c290af6-b1ed-4b33-9aa9-2898c1420270","404":"db4376de-666a-48f1-9a25-2903282ce3c3"},"method":"get","type":"path","servers":["1c1c7f27-0b9d-401e-a017-98e680c1df97","0f1d9766-b463-4e6d-94bd-1bfaad3810bb"],"security":["09abb6d5-3458-4339-bdbb-4391192bb989"],"path":"/v1/students/{id}","baseUrlOptions":["https://api.sandbox.gravitypay.app","https://api.gravitypay.app"],"title":"Consultar aluno","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0998ee55-b334-4f33-8d56-e4a3d18a165c":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"8fe2b228-b264-4d1f-b92a-bac63a341449":{"description":"Aluno com matrículas","content":{"application/json":{"schema":{"type":"object","description":"Aluno com todas as matrículas, como sai em GET /v1/students e GET /v1/students/{id}.","required":["enrollments","id","object","name","email","phone","avatarUrl","lastLoginAt","createdAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","enum":["student"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"name","typeLabel":"string | null"},"email":{"type":"string","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"phone":{"oneOf":[{"type":"string","description":"Telefone só com dígitos (no Brasil, DDD + número). Nulo quando o aluno não tem telefone cadastrado.","isRequired":true,"uniqueKey":"phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Telefone só com dígitos (no Brasil, DDD + número). Nulo quando o aluno não tem telefone cadastrado.","isRequired":true,"uniqueKey":"phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"phone","typeLabel":"string | null"},"avatarUrl":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"avatarUrl.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"avatarUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"avatarUrl","typeLabel":"string | null"},"lastLoginAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"lastLoginAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"lastLoginAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lastLoginAt","typeLabel":"string\u003cdate-time> | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"enrollments":{"type":"array","items":{"type":"object","required":["id","object","status","hasAccess","source","course","cohort","grantedAt","expiresAt","revokedAt","revokeReason","suspended","suspendedAt","suspendedReason","guaranteeEndsAt","paymentId","subscriptionId","createdAt"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].id","typeLabel":"string"},"object":{"type":"string","enum":["enrollment"],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["ACTIVE","REVOKED"],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"hasAccess":{"type":"boolean","description":"true quando a matrícula está ACTIVE, não está suspensa (suspended false) e expiresAt é nulo ou futuro.","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].hasAccess","typeLabel":"boolean"},"source":{"type":"string","enum":["PURCHASE","MANUAL"],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"course":{"type":"object","required":["id","title","productId"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].course.id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].course.title","typeLabel":"string"},"productId":{"type":"string","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].course.productId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].course","typeLabel":"object"},"cohort":{"type":"object","description":"Turma da matrícula, sempre preenchida.","required":["id","name","isDefault"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].cohort.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].cohort.name","typeLabel":"string"},"isDefault":{"type":"boolean","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].cohort.isDefault","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].cohort","typeLabel":"object"},"grantedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].grantedAt","typeLabel":"string\u003cdate-time>"},"expiresAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].expiresAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].expiresAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].expiresAt","typeLabel":"string\u003cdate-time> | null"},"revokedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].revokedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].revokedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].revokedAt","typeLabel":"string\u003cdate-time> | null"},"revokeReason":{"oneOf":[{"type":"string","enum":["REFUND","CHARGEBACK","SUBSCRIPTION_ENDED","SELLER",null],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].revokeReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["REFUND","CHARGEBACK","SUBSCRIPTION_ENDED","SELLER",null],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].revokeReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].revokeReason","typeLabel":"enum\u003cstring> | null"},"suspended":{"type":"boolean","description":"true quando a escola suspendeu o acesso temporariamente. O aluno continua com direito ao curso (status segue ACTIVE), mas hasAccess fica false até a suspensão ser retirada.","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].suspended","typeLabel":"boolean"},"suspendedAt":{"oneOf":[{"type":"string","format":"date-time","description":"Quando a suspensão começou. null quando não está suspensa.","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].suspendedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Quando a suspensão começou. null quando não está suspensa.","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].suspendedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].suspendedAt","typeLabel":"string\u003cdate-time> | null"},"suspendedReason":{"oneOf":[{"type":"string","description":"Motivo da suspensão, escrito pela escola. null quando não está suspensa.","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].suspendedReason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Motivo da suspensão, escrito pela escola. null quando não está suspensa.","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].suspendedReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].suspendedReason","typeLabel":"string | null"},"guaranteeEndsAt":{"oneOf":[{"type":"string","format":"date-time","description":"Fim da trava de garantia. null em matrícula sem trava.","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].guaranteeEndsAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Fim da trava de garantia. null em matrícula sem trava.","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].guaranteeEndsAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].guaranteeEndsAt","typeLabel":"string\u003cdate-time> | null"},"paymentId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].paymentId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].paymentId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].paymentId","typeLabel":"string | null"},"subscriptionId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].subscriptionId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].subscriptionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"enrollments.items.[INDEX].subscriptionId","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"enrollments.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"enrollments.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"enrollments","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"clx1student01","object":"student","name":"Maria Souza","email":"maria@example.com","phone":"11987654321","avatarUrl":null,"lastLoginAt":"2026-09-10T08:00:00.000Z","createdAt":"2026-06-11T14:20:00.000Z","enrollments":[]},"examples":{"Example":{"title":"Example","value":{"id":"clx1student01","object":"student","name":"Maria Souza","email":"maria@example.com","phone":"11987654321","avatarUrl":null,"lastLoginAt":"2026-09-10T08:00:00.000Z","createdAt":"2026-06-11T14:20:00.000Z","enrollments":[]}}},"exampleType":"examples"}},"exampleType":"examples"},"b572a019-cdf4-4c6e-b6b5-31e6a029134e":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","description":"`authentication` (401), `insufficient_scope` (403), `forbidden` (403, rota de parceiro chamada por outra loja), `invalid_request` (400), `not_found` (404) e, no pagamento transparente, `payment_declined` (402), `conflict` (409), `unprocessable` (422) e `gateway_error` (502).","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Detalhe do `type` no pagamento transparente: `charge_not_pending`, `payment_in_progress`, `method_unavailable`, `card_input_not_supported`, `payment_declined` ou `gateway_error`.","uniqueKey":"error.code","typeLabel":"string"},"param":{"type":"string","description":"Parâmetro que falhou, em `invalid_request`.","uniqueKey":"error.param","typeLabel":"string"},"requiredScope":{"type":"string","description":"Escopo que falta, em `insufficient_scope`.","uniqueKey":"error.requiredScope","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>","requiredScope":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"8c290af6-b1ed-4b33-9aa9-2898c1420270":{"description":"A chave é válida, mas não tem o escopo exigido pela operação.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","description":"`authentication` (401), `insufficient_scope` (403), `forbidden` (403, rota de parceiro chamada por outra loja), `invalid_request` (400), `not_found` (404) e, no pagamento transparente, `payment_declined` (402), `conflict` (409), `unprocessable` (422) e `gateway_error` (502).","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Detalhe do `type` no pagamento transparente: `charge_not_pending`, `payment_in_progress`, `method_unavailable`, `card_input_not_supported`, `payment_declined` ou `gateway_error`.","uniqueKey":"error.code","typeLabel":"string"},"param":{"type":"string","description":"Parâmetro que falhou, em `invalid_request`.","uniqueKey":"error.param","typeLabel":"string"},"requiredScope":{"type":"string","description":"Escopo que falta, em `insufficient_scope`.","uniqueKey":"error.requiredScope","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"type":"insufficient_scope","message":"Esta chave de API não tem o escopo students:read.","requiredScope":"students:read"}},"examples":{"Example":{"title":"Example","value":{"error":{"type":"insufficient_scope","message":"Esta chave de API não tem o escopo students:read.","requiredScope":"students:read"}}}},"exampleType":"examples"}},"exampleType":"examples"},"db4376de-666a-48f1-9a25-2903282ce3c3":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","description":"`authentication` (401), `insufficient_scope` (403), `forbidden` (403, rota de parceiro chamada por outra loja), `invalid_request` (400), `not_found` (404) e, no pagamento transparente, `payment_declined` (402), `conflict` (409), `unprocessable` (422) e `gateway_error` (502).","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","description":"Detalhe do `type` no pagamento transparente: `charge_not_pending`, `payment_in_progress`, `method_unavailable`, `card_input_not_supported`, `payment_declined` ou `gateway_error`.","uniqueKey":"error.code","typeLabel":"string"},"param":{"type":"string","description":"Parâmetro que falhou, em `invalid_request`.","uniqueKey":"error.param","typeLabel":"string"},"requiredScope":{"type":"string","description":"Escopo que falta, em `insufficient_scope`.","uniqueKey":"error.requiredScope","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","message":"\u003cstring>","code":"\u003cstring>","param":"\u003cstring>","requiredScope":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"09abb6d5-3458-4339-bdbb-4391192bb989":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"1c1c7f27-0b9d-401e-a017-98e680c1df97":{"url":"https://api.sandbox.gravitypay.app","description":"Sandbox (testes) — alvo do try-it"},"0f1d9766-b463-4e6d-94bd-1bfaad3810bb":{"url":"https://api.gravitypay.app","description":"Produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"gravityplay","siteName":"Gravity Play","title":"Consultar aluno - Gravity Play","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T14:32:06.552Z","originalFileLocation":"api-reference/alunos/consultar-aluno.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retorna o aluno com todas as matrículas, no mesmo formato de um item de GET /v1/students. Aluno de outra loja ou de pré-visualização responde 404. Escopo exigido: students:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gravity Play\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Consultar aluno - Gravity Play\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retorna o aluno com todas as matrículas, no mesmo formato de um item de GET /v1/students. Aluno de outra loja ou de pré-visualização responde 404. Escopo exigido: students:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gravity Play\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gravityplay.mintlify.app/_mintlify/api/og/v2?division=Alunos\u0026amp;title=Consultar+aluno\u0026amp;description=Retorna+o+aluno+com+todas+as+matr%C3%ADculas%2C+no+mesmo+formato+de+um+item+de+%60GET+%2Fv1%2Fstudents%60.+Aluno+de+outra+loja+ou+de+pr%C3%A9-visualiza%C3%A7%C3%A3o+responde+404.%0A%0AEscopo+exi\u0026amp;theme=91ba7479a4ba67b966427c49\u0026amp;signature=88b66f9c9e64fa89b6420dcf72ea123abcd1cd91fe333045b515145c84e61fcd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Consultar aluno - Gravity Play\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retorna o aluno com todas as matrículas, no mesmo formato de um item de GET /v1/students. Aluno de outra loja ou de pré-visualização responde 404. Escopo exigido: students:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gravityplay.mintlify.app/_mintlify/api/og/v2?division=Alunos\u0026amp;title=Consultar+aluno\u0026amp;description=Retorna+o+aluno+com+todas+as+matr%C3%ADculas%2C+no+mesmo+formato+de+um+item+de+%60GET+%2Fv1%2Fstudents%60.+Aluno+de+outra+loja+ou+de+pr%C3%A9-visualiza%C3%A7%C3%A3o+responde+404.%0A%0AEscopo+exi\u0026amp;theme=91ba7479a4ba67b966427c49\u0026amp;signature=88b66f9c9e64fa89b6420dcf72ea123abcd1cd91fe333045b515145c84e61fcd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/gravityplay/K1lL00SbZCa1K75h/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gravity Play\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EA580C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/alunos/consultar-aluno.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gravitypay.app/#organization\",\"name\":\"Gravity Play\",\"url\":\"https://docs.gravitypay.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gravityplay/b7AIIk7hcK-Pou2a/logo/light.png?fit=max\u0026auto=format\u0026n=b7AIIk7hcK-Pou2a\u0026q=85\u0026s=098c877fccb72289c5e070695f803600\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gravitypay.app#website\",\"name\":\"Gravity Play\",\"url\":\"https://docs.gravitypay.app\",\"publisher\":{\"@id\":\"https://docs.gravitypay.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno#webpage\",\"url\":\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno\",\"name\":\"Consultar aluno\",\"description\":\"Retorna o aluno com todas as matrículas, no mesmo formato de um item de GET /v1/students. Aluno de outra loja ou de pré-visualização responde 404. Escopo exigido: students:read.\",\"dateModified\":\"2026-10-22T14:32:06.552Z\",\"isPartOf\":{\"@id\":\"https://docs.gravitypay.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Alunos\",\"item\":\"https://docs.gravitypay.app/api-reference/alunos/listar-alunos\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Consultar aluno\",\"item\":\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno#apireference\",\"headline\":\"Consultar aluno\",\"name\":\"Consultar aluno\",\"description\":\"Retorna o aluno com todas as matrículas, no mesmo formato de um item de GET /v1/students. Aluno de outra loja ou de pré-visualização responde 404. Escopo exigido: students:read.\",\"url\":\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gravitypay.app/api-reference/alunos/consultar-aluno#webpage\"},\"dateModified\":\"2026-10-22T14:32:06.552Z\",\"publisher\":{\"@id\":\"https://docs.gravitypay.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gravitypay.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gravity Play\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gravity Play","nav":{"global":null,"tabs":[{"tab":"Guias","pages":[{"title":"Guias","href":""}]},{"tab":"Referência da API","groups":[{"group":"Cobranças","pages":[{"title":"Criar cobrança","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/charges","href":"/api-reference/cobranças/criar-cobrança"},{"title":"Consultar cobrança","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/charges/{id}","href":"/api-reference/cobranças/consultar-cobrança"},{"title":"Pagar cobrança (pagamento transparente)","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/charges/{id}/payments","href":"/api-reference/cobranças/pagar-cobrança-pagamento-transparente"},{"title":"Métodos de pagamento da loja","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payment-methods","href":"/api-reference/cobranças/métodos-de-pagamento-da-loja"}]},{"group":"Pagamentos","pages":[{"title":"Listar cobranças","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/payments","href":"/api-reference/pagamentos/listar-cobranças"},{"title":"Listar vendedores","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/sales-reps","href":"/api-reference/pagamentos/listar-vendedores"}]},{"group":"Assinaturas","pages":[{"title":"Listar assinaturas","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/subscriptions","href":"/api-reference/assinaturas/listar-assinaturas"}]},{"group":"Cursos","pages":[{"title":"Listar cursos","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/courses","href":"/api-reference/cursos/listar-cursos"},{"title":"Consultar curso","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/courses/{id}","href":"/api-reference/cursos/consultar-curso"}]},{"group":"Turmas","pages":[{"title":"Listar turmas","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/cohorts","href":"/api-reference/turmas/listar-turmas"}]},{"group":"Alunos","pages":[{"title":"Listar alunos","description":"Lista paginada dos alunos da loja da chave, cada um com todas as matrículas. Os filtros de matrícula (`courseId`, `cohortId`, `enrollmentStatus`) devolvem os alunos com ao menos uma matrícula que casa com todos eles, e `enrollments` continua com todas as matrículas. O aluno de pré-visualização do seller nunca aparece. Ordem: `createdAt` decrescente e, no empate, `id` decrescente. As matrículas de `enrollments` vêm por `createdAt` crescente e, no empate, `id` crescente.\n\nEscopo exigido: `students:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/students","href":"/api-reference/alunos/listar-alunos"},{"title":"Consultar aluno","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/students/{id}","href":"/api-reference/alunos/consultar-aluno"},{"title":"Progresso do aluno","description":"Retorna o progresso detalhado de cada matrícula do aluno, inclusive revogada ou vencida, sem paginação. `totalLessons` conta só as aulas publicadas, de módulos publicados, que a turma da matrícula vê. Aluno de outra loja ou de pré-visualização responde 404; `courseId` de outra loja responde 400.\n\nEscopo exigido: `students:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/students/{id}/progress","href":"/api-reference/alunos/progresso-do-aluno"}]}]}]},"basePath":"","title":"Consultar aluno - Gravity Play","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}