curl -X GET 'https://api.goatpay.com.br/v1/oauth-apps/get/clx_app_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Aplicação OAuth consultada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro",
"description": "Integração de cobranças",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read"],
"developerName": "Sua Empresa LTDA",
"website": "https://sua-app.com",
"lastUsedAt": "2026-09-03T18:30:00.000Z",
"createdAt": "2026-08-15T10:00:00.000Z",
"clients": [
{
"id": "clx_client_prod",
"environment": "PRODUCTION",
"clientId": "gp_oauth_live_x9y8z7...",
"clientSecretPreview": "gp_oauth_live_...****",
"status": "ACTIVE",
"redirectUris": [
{ "id": "clx_uri_2", "uri": "https://sua-app.com/oauth/callback" }
]
}
]
}
},
"requestId": "req_oauth_get"
}
Gestão
Consultar aplicação OAuth
Retorna uma aplicação OAuth por ID, com clients e redirect URIs.
GET
/
oauth-apps
/
get
/
{id}
curl -X GET 'https://api.goatpay.com.br/v1/oauth-apps/get/clx_app_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Aplicação OAuth consultada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro",
"description": "Integração de cobranças",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read"],
"developerName": "Sua Empresa LTDA",
"website": "https://sua-app.com",
"lastUsedAt": "2026-09-03T18:30:00.000Z",
"createdAt": "2026-08-15T10:00:00.000Z",
"clients": [
{
"id": "clx_client_prod",
"environment": "PRODUCTION",
"clientId": "gp_oauth_live_x9y8z7...",
"clientSecretPreview": "gp_oauth_live_...****",
"status": "ACTIVE",
"redirectUris": [
{ "id": "clx_uri_2", "uri": "https://sua-app.com/oauth/callback" }
]
}
]
}
},
"requestId": "req_oauth_get"
}
Permissão:
oauth-apps/get.
curl -X GET 'https://api.goatpay.com.br/v1/oauth-apps/get/clx_app_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE'
{
"success": true,
"message": "Aplicação OAuth consultada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro",
"description": "Integração de cobranças",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read"],
"developerName": "Sua Empresa LTDA",
"website": "https://sua-app.com",
"lastUsedAt": "2026-09-03T18:30:00.000Z",
"createdAt": "2026-08-15T10:00:00.000Z",
"clients": [
{
"id": "clx_client_prod",
"environment": "PRODUCTION",
"clientId": "gp_oauth_live_x9y8z7...",
"clientSecretPreview": "gp_oauth_live_...****",
"status": "ACTIVE",
"redirectUris": [
{ "id": "clx_uri_2", "uri": "https://sua-app.com/oauth/callback" }
]
}
]
}
},
"requestId": "req_oauth_get"
}
Parâmetros
string
required
ID da aplicação OAuth.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)

