Sign in

v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Listar onboardings

Lista as solicitações de cadastros feitas.

get/clients

Query parameters

p[per_page]string

Quantidade de itens para retornar por página.

p[page]string

Página a ser carregada.

q[statusEq]'awaiting_onboarding' | 'awaiting_validation' | 'awaiting_review' | 'awaiting_security_analysis' | 'approved' | 'rejected' | 'canceled'

Status do onboarding igual a.

q[documentNumberContNumbers]integer

CNPJ da empresa igual a.

q[nameCont]string

Nome fantasia da empresa contém ou é igual a.

q[companyNameCont]string

Razão social da empresa contém ou é igual a.

q[createdAtGteq]string date

Data de solicitação do cadastro maior igual que.

q[createdAtLteq]string date

Data de solicitação do cadastro menor igual que.

q[updatedAtGteq]string date

Data de atualização no status do cadastro maior igual que.

q[updatedAtLteq]string date

Data de atualização no status do cadastro menor igual que.

Response

200

Example response

{
  "data": [
    {
      "id": "446753cb-4979-467a-b14b-add28241fb3f",
      "type": "client",
      "attributes": {
        "status": "awaiting_onboarding",
        "documentNumber": "12342516000135",
        "name": "Feel Good Inc",
        "companyName": "Feel Good",
        "onboardingUrl": "https://cadastros.grafeno.be/onboardings/v2/pages/natureza-juridica?token=5c13b8d3-5336-4fc1-bd6f-f3e3b42ddf72",
        "createdAt": "2024-04-04T14:39:58.143-03:00",
        "updatedAt": "2024-04-04T14:39:58.751-03:00"
      }
    }
  ],
  "meta": {
    "pagination": {
      "currentPage": 1,
      "nextPage": 2,
      "perPage": 25,
      "totalPages": 5,
      "totalCount": 122
    }
  }
}