Skip to main content
GET
/
organizations
/
{organizationId}
/
offboarding-requests
Listar Solicitacoes de Offboarding
curl --request GET \
  --url https://api.example.com/organizations/{organizationId}/offboarding-requests \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "offboardingRequestId": "019525fe-4b30-7cb6-beda-6e8f0a2c4d6a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "action": "START_RETENTION",
      "reason": "HIGH_COST",
      "reasonDetail": "Valor acima do orcamento",
      "notes": null,
      "campaignMode": "SUSPENDED",
      "billingMode": "FREE",
      "billingBehavior": "keep_as_draft",
      "retentionDeadline": "2026-02-14T10:00:00.000Z",
      "retentionResolution": "RETAINED",
      "status": "RETAINED",
      "requestedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "requestedAt": "2026-01-15T10:00:00.000Z",
      "resolvedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "resolvedAt": "2026-01-20T14:00:00.000Z",
      "cancelledBy": null,
      "cancelledBySystem": null,
      "cancelledReason": null,
      "cancelledAt": null,
      "cancellationDetails": null,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-20T14:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "totalItems": 3,
    "totalPages": 1
  }
}
Retorna uma lista paginada of offboarding requests for the organization.
Requer permissao offboarding:read.

​
Headers

​
Authorization
string
required
Bearer token.

​
Parametros de Path

​
organizationId
string
required
Organization ID (UUIDv7).

​
Parametros de Query

​
page
integer
Numero da pagina.
​
limit
integer
Resultados por pagina.

​
Resposta

{
  "data": [
    {
      "offboardingRequestId": "019525fe-4b30-7cb6-beda-6e8f0a2c4d6a",
      "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
      "action": "START_RETENTION",
      "reason": "HIGH_COST",
      "reasonDetail": "Valor acima do orcamento",
      "notes": null,
      "campaignMode": "SUSPENDED",
      "billingMode": "FREE",
      "billingBehavior": "keep_as_draft",
      "retentionDeadline": "2026-02-14T10:00:00.000Z",
      "retentionResolution": "RETAINED",
      "status": "RETAINED",
      "requestedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "requestedAt": "2026-01-15T10:00:00.000Z",
      "resolvedBy": "019525fd-56a8-7db4-8c3e-2a1b4d6f8e0c",
      "resolvedAt": "2026-01-20T14:00:00.000Z",
      "cancelledBy": null,
      "cancelledBySystem": null,
      "cancelledReason": null,
      "cancelledAt": null,
      "cancellationDetails": null,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-20T14:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "totalItems": 3,
    "totalPages": 1
  }
}

​
Exemplos de Codigo

curl https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/offboarding-requests?page=1&limit=20 \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
500internal_server_errorOcorreu um erro inesperado