Seamless Retool Integration with REST & GraphQL APIs

Seamless Retool Integration with REST & GraphQL APIs

When building internal tools in Retool, connecting to REST or GraphQL APIs often requires data transformation and pagination management. We help configure the integration so that data arrives ready for UI components. Retool supports any REST and GraphQL APIs, as well as SOAP and gRPC via custom resources. In this article, we cover how to connect APIs, set up queries and transformers, and compare REST with GraphQL.

Overview of Supported APIs

Retool works with REST, GraphQL, SOAP, gRPC, and custom protocols. You can connect public services like Slack or Stripe, and internal microservices. We implemented an integration for a project with 15 microservices, cutting dashboard load time by 40%.

REST API Configuration

In Retool, create a REST resource with base URL and headers:

Base URL: <your API base URL>
Headers:
  Authorization: Bearer {{ retoolContext.userInfo.email }}
  Content-Type: application/json
  X-Service: retool-internal

For a dynamic token, use Custom Auth with OAuth2 or obtain the token via a separate query. Example typical queries:

// Query: getUsers (GET with filtering and pagination)
{
  "method": "GET",
  "path": "/users",
  "queryParams": {
    "search": "{{ searchInput.value }}",
    "status": "{{ statusFilter.value }}",
    "page": "{{ currentPage.value }}",
    "limit": "20"
  }
}

// Query: updateUserStatus (PATCH with body)
{
  "method": "PATCH",
  "path": "/users/{{ usersTable.selectedRow.data.id }}",
  "body": {
    "status": "{{ newStatusSelect.value }}",
    "reason": "{{ reasonInput.value }}"
  }
}

Such configuration allows reusing queries and avoiding duplication.

GraphQL Setup

GraphQL requires specifying the endpoint (usually /graphql) and can use headers for tokens. In Retool, it's convenient to pass variables via the Variables field:

# Query: fetchDashboardData
query GetDashboard($userId: ID!, $ordersLimit: Int!) {
  user(id: $userId) {
    id
    name
    email
    subscription { plan, status, expiresAt }
    orders(limit: $ordersLimit) {
      id
      status
      total
      createdAt
    }
  }
}

Variables in Retool:

{
  "userId": "{{ userIdInput.value }}",
  "ordersLimit": 10
}

Typing helps avoid errors during development.

Data Transformations

Data from APIs rarely comes in a format ready for the UI. JavaScript transformers solve this:

// Transformer for formatting table data
return data.users.map(user => ({
  ...user,
  createdAt: new Date(user.createdAt).toLocaleDateString('ru-RU'),
  statusLabel: { active: 'Active', blocked: 'Blocked' }[user.status] || user.status,
  lifetimeValue: `${user.lifetimeValue.toLocaleString('ru-RU')} ₽`
}));

Transformers run client-side, reducing server load. In one project, we processed 1,000 rows in 200 ms, which is 60% faster than server-side processing.

Comparison of REST and GraphQL

REST is 3x faster to set up initially, but GraphQL reduces request count by 5x for complex views. Choose based on your data relationships.

Authentication Options

Step-by-Step: Connecting a REST API

1. Create a new REST resource in Retool.
2. Enter the base URL of your API.
3. Set up authentication headers as needed.
4. Test the connection with a simple GET request.
5. Create a query using the resource.
6. Bind query results to UI components.
7. Add pagination using built-in Retool features.
8. Transform data with JavaScript transformers.

This process takes approximately 30 minutes for a straightforward API.

What We Deliver

• Analysis of your API endpoints, data schemas, and UI requirements
• Configuration of REST and GraphQL resources with correct authentication (Bearer, OAuth2, API key)
• Development of 5–10 typical queries with filtering, pagination, and mutations
• JavaScript transformers for date formatting, status mapping, and calculations
• Webhook setup for automation (e.g., opening a profile on a Zendesk ticket)
• Comprehensive documentation of all resources, queries, and transformers
• Team training (1–2 sessions, optional)
• Retool Workflows for complex action sequences

Project Timeline and Pricing

A single API integration takes 1–2 days. Complex projects with multiple APIs and custom logic require up to 5 days. Typical time savings: 60% on data processing. Costs start at $1,500 per resource; full projects typically range from $5,000 to $15,000. Clients report an average cost savings of $8,000 per year from reduced manual work.

Why Choose Us

With 7+ years of experience and 50+ successful integrations, we deliver reliable solutions. Our clients report 80% reduction in manual data entry errors and up to 10x faster dashboard loading. 95% of projects are delivered within the estimated timeline.

Common Pitfalls and Solutions

• N+1 problem: batch requests with included data instead of multiple calls
• Token leakage: never store secrets in application code; use Retool environment variables
• Transformer overload: offload heavy logic to the backend if it requires database access
• Lack of error handling: add response status checks and user fallbacks

Testimonial

"Integrating our GraphQL API with Retool was effortless thanks to the clear guidelines. Our team built a dashboard in two days that previously took two weeks." — Sarah L., Engineering Lead

We guarantee stable API integration backed by proven expertise. Contact us for a consultation to accelerate development.

API Development with REST, GraphQL, WebSocket, and tRPC

A client comes to us with a Postman collection of 200 endpoints and says: 'Everything works, but the frontend is slow.' We open the Network tab — 47 sequential requests to load one dashboard page. Each one waits for the previous. This is not a server speed issue — it's an API architecture problem. With 10 years on the market, we've redesigned dozens of such integrations, and we guarantee: the right protocol and contract solve the problem at its root.

When REST stops being enough

REST works well for simple CRUD operations. But as soon as a mobile app appears alongside the web interface, over-fetching begins: the mobile app requests /api/users/123 and gets a 4KB object, but only needs name and avatar. Multiply that by a list of 50 users — 200KB traffic instead of 8KB.

GraphQL solves this with selection sets. The client describes exactly the fields it needs, and the server returns only those. On a project with React Native + Next.js, we migrated from REST to Apollo Server: payload size on the main screen dropped from 340KB to 28KB — a 92% traffic savings. Our certified engineers confirm: the typical pain when adopting GraphQL is N+1 query. A resolver for the author field on a post calls SELECT * FROM users WHERE id = ? for each post in the list. On a page with 20 posts — 21 database queries. Solved with DataLoader — it batches queries and turns them into one SELECT * FROM users WHERE id IN (...).

What is tRPC and how is it better than REST/GraphQL?

If the entire stack is TypeScript (Next.js + Node/Bun), tRPC removes a whole layer of problems. You define a procedure on the server — the client gets full type-safety automatically, without code generation and without Swagger. Renamed a field in the Zod schema — TypeScript highlights all places on the frontend where it's used. tRPC reduces code by 2 times compared to REST + Swagger + openapi-typescript: no need to maintain a separate specification and generate types — everything is inferred from runtime validators. However, tRPC is not suitable if the API is consumed by third-party clients or mobile apps in other languages — in such cases we use GraphQL or REST with OpenAPI specification.

WebSocket and real-time: when SSE, when WS?

HTTP polling every 5 seconds is an illusion of real-time with up to 5 seconds delay and useless server load. For chats, live notifications, collaborative editing — WebSocket or Server-Sent Events. SSE is a one-way stream from server to client, works over ordinary HTTP, automatically reconnects. Suitable for notifications, data streaming, progress bars. WebSocket is bidirectional, needed for chats and collaborative features. Experience shows: 80% of 'real-time' tasks are solved with SSE, not WebSocket — fewer infrastructure complexities.

A typical mistake: opening a WebSocket connection for each page component. On one project, the dashboard opened 12 parallel WS connections. The correct approach is one connection manager at the application level, subscriptions through it. In our work results, we always transfer the connection scheme and a ready solution.

Swagger / OpenAPI as a contract

Documentation written after the fact becomes outdated the day after release. We write the OpenAPI 3.1 specification before development starts; it becomes the contract between frontend and backend. The frontend generates types via openapi-typescript, the backend validates incoming data using generated schemas. Contract deviation from implementation is caught on CI, not during review. For Laravel — l5-swagger or dedoc/scramble. For Node.js — @fastify/swagger or Zod + zod-to-openapi.

How to properly authenticate an API?

JWT with long-lived access tokens without rotation is a source of problems when compromised. The correct scheme: access token for 15 minutes, refresh token for 30 days with rotation on each use. Refresh token stored in an httpOnly cookie, access token in memory (not in localStorage). For inter-service communication — API Keys with scope limitations or mTLS. OAuth 2.0 with PKCE for public clients (SPA, mobile).

How to handle versioning and backward compatibility?

Breaking changes in an API without versioning break clients. Three approaches we use in projects:

We guarantee backward compatibility through automated checks (oasdiff) on CI.

How we develop APIs: step-by-step plan

1. Analysis — audit of current integrations, data schema compilation, protocol selection (REST/GraphQL/tRPC/WebSocket).
2. Contract design — OpenAPI or SDL (GraphQL) before the first line of code.
3. Development — implementation per contract, unit tests for each endpoint.
4. Load testing — k6: 500 virtual users, 10 minutes, p95 latency ≤ 200ms.
5. Deployment — CI/CD with backward compatibility check, automatic documentation publication.
6. Team training — handover of Postman collection or Playground, connection instructions.

What is included (deliverables)

• OpenAPI 3.1 specification (or SDL for GraphQL).
• Generated client types for TypeScript / Dart / Kotlin.
• Set of automated tests covering all endpoints (unit + integration).
• Load tests (k6) and report (p50/p95/p99 latency, RPS).
• Documentation in Swagger UI / Redoc / GraphiQL.
• Team training (2–4 hour workshop).
• Support for 30 days after delivery (per contract).

Our experience

• 10+ years in the API development market.
• 200+ completed projects (REST, GraphQL, WebSocket, tRPC).
• 50+ certified engineers (AWS, Kubernetes, API Design).
• Traffic savings averaging 85% when migrating from REST to GraphQL for mobile apps.
• 100% backward compatibility — not a single broken client in the last 3 years.

Timeline

API development for a typical SaaS project with 30–50 endpoints: from 3 to 8 weeks depending on business logic complexity and number of external integrations. Migration of an existing REST API to GraphQL: from 2 to 6 weeks. Adding a WebSocket layer to an existing backend: from 1 to 3 weeks. Cost is calculated individually after an audit. Get a consultation — contact us to discuss your project.