--- agentTools: projectIndex: https://docs.grafeno.digital/llms.txt --- # Listar onboardings Lista as solicitações de cadastros feitas. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Cadastros - V2", "version": "3.0.0" }, "servers": [ { "url": "https://cadastros.grafeno.be/api/onboardings/v2/complete/" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "Authorization", "in": "header", "x-bearer-format": "" } } }, "security": [ { "sec0": [] } ], "paths": { "/clients": { "get": { "summary": "Listar onboardings", "description": "Lista as solicitações de cadastros feitas.", "operationId": "list-onboardings", "parameters": [ { "name": "p[per_page]", "in": "query", "description": "Quantidade de itens para retornar por página.", "schema": { "type": "string" } }, { "name": "p[page]", "in": "query", "description": "Página a ser carregada.", "schema": { "type": "string" } }, { "name": "q[statusEq]", "in": "query", "description": "Status do onboarding igual a.", "schema": { "type": "string", "enum": [ "awaiting_onboarding", "awaiting_validation", "awaiting_review", "awaiting_security_analysis", "approved", "rejected", "canceled" ] } }, { "name": "q[documentNumberContNumbers]", "in": "query", "description": "CNPJ da empresa igual a.", "schema": { "type": "integer", "format": "int32" } }, { "name": "q[nameCont]", "in": "query", "description": "Nome fantasia da empresa contém ou é igual a.", "schema": { "type": "string" } }, { "name": "q[companyNameCont]", "in": "query", "description": "Razão social da empresa contém ou é igual a.", "schema": { "type": "string" } }, { "name": "q[createdAtGteq]", "in": "query", "description": "Data de solicitação do cadastro maior igual que.", "schema": { "type": "string", "format": "date" } }, { "name": "q[createdAtLteq]", "in": "query", "description": "Data de solicitação do cadastro menor igual que.", "schema": { "type": "string", "format": "date" } }, { "name": "q[updatedAtGteq]", "in": "query", "description": "Data de atualização no status do cadastro maior igual que.", "schema": { "type": "string", "format": "date" } }, { "name": "q[updatedAtLteq]", "in": "query", "description": "Data de atualização no status do cadastro menor igual que.", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"id\": \"446753cb-4979-467a-b14b-add28241fb3f\",\n \"type\": \"client\",\n \"attributes\": {\n \"status\": \"awaiting_onboarding\",\n \"documentNumber\": \"12342516000135\",\n \"name\": \"Feel Good Inc\",\n \"companyName\": \"Feel Good\",\n \"onboardingUrl\": \"https://cadastros.grafeno.be/onboardings/v2/pages/natureza-juridica?token=5c13b8d3-5336-4fc1-bd6f-f3e3b42ddf72\",\n \"createdAt\": \"2024-04-04T14:39:58.143-03:00\",\n \"updatedAt\": \"2024-04-04T14:39:58.751-03:00\"\n }\n },\n {\n \"id\": \"1869d789-0dca-4e05-9be5-8ca564a1dd28\",\n \"type\": \"client\",\n \"attributes\": {\n \"status\": \"awaiting_validation\",\n \"documentNumber\": \"43212516000135\",\n \"name\": \"Schrute Farms\",\n \"companyName\": \"Schrute Farms\",\n \"onboardingUrl\": \"https://cadastros.grafeno.be/onboardings/v2/pages/natureza-juridica?token=72538f22-3461-4fda-84e9-4adaeebd02ce\",\n \"createdAt\": \"2024-03-25T16:26:10.216-03:00\",\n \"updatedAt\": \"2024-04-03T22:18:34.842-03:00\"\n }\n },\n {\n \"id\": \"08dd1f50-fc4d-4ce0-b5b8-ae5336596177\",\n \"type\": \"client\",\n \"attributes\": {\n \"status\": \"approved\",\n \"documentNumber\": \"76553395000164\",\n \"name\": \"Dunder Mifflin\",\n \"companyName\": \"Dunder Mifflin Paper Company\",\n \"onboardingUrl\": \"https://cadastros.grafeno.be/onboardings/v2/pages/natureza-juridica?token=e89c8e05-0f96-4cf0-a2d2-5716336db495\",\n \"createdAt\": \"2024-03-07T15:23:36.341-03:00\",\n \"updatedAt\": \"2024-03-07T15:29:20.028-03:00\"\n }\n },\n {\n \"id\": \"018af8c0-570f-41ca-9487-9c7471de4417\",\n \"type\": \"client\",\n \"attributes\": {\n \"status\": \"awaiting_missing_information\",\n \"documentNumber\": \"32080007000150\",\n \"name\": \"WayStar Royco\",\n \"companyName\": \"WayStar Royco\",\n \"onboardingUrl\": \"https://cadastros.grafeno.be/onboardings/v2/pages/natureza-juridica?token=049bdba1-0848-47e5-ac19-b24f4f35213b\",\n \"createdAt\": \"2023-11-10T14:31:17.012-03:00\",\n \"updatedAt\": \"2024-02-19T13:49:13.248-03:00\"\n }\n }\n ],\n \"meta\": {\n \"search\": {},\n \"pagination\": {\n \"currentPage\": 1,\n \"previousPage\": null,\n \"nextPage\": 2,\n \"perPage\": 25,\n \"totalPages\": 5,\n \"totalCount\": 122\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "446753cb-4979-467a-b14b-add28241fb3f" }, "type": { "type": "string", "example": "client" }, "attributes": { "type": "object", "properties": { "status": { "type": "string", "example": "awaiting_onboarding" }, "documentNumber": { "type": "string", "example": "12342516000135" }, "name": { "type": "string", "example": "Feel Good Inc" }, "companyName": { "type": "string", "example": "Feel Good" }, "onboardingUrl": { "type": "string", "example": "https://cadastros.grafeno.be/onboardings/v2/pages/natureza-juridica?token=5c13b8d3-5336-4fc1-bd6f-f3e3b42ddf72" }, "createdAt": { "type": "string", "example": "2024-04-04T14:39:58.143-03:00" }, "updatedAt": { "type": "string", "example": "2024-04-04T14:39:58.751-03:00" } } } } } }, "meta": { "type": "object", "properties": { "search": { "type": "object", "properties": {} }, "pagination": { "type": "object", "properties": { "currentPage": { "type": "integer", "example": 1, "default": 0 }, "previousPage": {}, "nextPage": { "type": "integer", "example": 2, "default": 0 }, "perPage": { "type": "integer", "example": 25, "default": 0 }, "totalPages": { "type": "integer", "example": 5, "default": 0 }, "totalCount": { "type": "integer", "example": 122, "default": 0 } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"errors\": [\n \"Você precisa entrar ou registrar-se antes de continuar.\"\n ]\n}" } }, "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string", "example": "Você precisa entrar ou registrar-se antes de continuar." } } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "660ea9b3f8253b0011474422:660ee85086c5900024f2e30d" } ```