REST API Response – JSON to Typedef Example

Convert a real-world REST API response with pagination, nested resources, and metadata into typed interfaces. A practical example for frontend developers.

What this demonstrates: This mimics a real REST API response with pagination, nested user profiles, permission arrays, and request metadata with rate limiting. Set the root name to 'GetUsersResponse' for a descriptive, reusable type that accurately represents your API contract.

Target Language

Root Type Name

JSON Input

{
  "status": "success",
  "data": {
    "users": [
      {
        "id": 1,
        "name": "Alice Johnson",
        "email": "alice@company.com",
        "role": "admin",
        "permissions": ["read", "write", "delete"],
        "profile": {
          "avatar": "https://cdn.example.com/avatars/1.jpg",
          "department": "Engineering",
          "joinedAt": "2023-01-15T00:00:00Z"
        }
      },
      {
        "id": 2,
        "name": "Bob Smith",
        "email": "bob@company.com",
        "role": "editor",
        "permissions": ["read", "write"],
        "profile": {
          "avatar": "https://cdn.example.com/avatars/2.jpg",
          "department": "Marketing",
          "joinedAt": "2023-06-20T00:00:00Z"
        }
      }
    ],
    "pagination": {
      "currentPage": 1,
      "totalPages": 5,
      "perPage": 10,
      "totalItems": 47,
      "hasNext": true,
      "hasPrevious": false
    }
  },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2024-03-15T14:30:00Z",
    "apiVersion": "v2",
    "rateLimit": {
      "remaining": 98,
      "limit": 100,
      "resetAt": "2024-03-15T15:00:00Z"
    }
  }
}

TypeScript Output

Paste JSON on the left to generate typedefs

Supports Nested Objects and Arrays

Our converter recursively processes deeply nested JSON structures, including arrays of objects, mixed-type arrays, and multi-level object hierarchies. Each nested object gets its own named interface (TypeScript) or class (C#) with properly typed properties.

Optional Fields and Mixed Types Handled

When a field is null in your JSON, it's automatically marked as optional in TypeScript (with ?) or nullable in C#. Arrays with mixed element types produce union types or fallback to object.

How to Use This JSON to Typedef Converter

Paste JSON

Paste or type your JSON into the input area on the left.

Choose Language

Select TypeScript or C# from the dropdown.

Copy Output

Your type definitions appear instantly. Click Copy to use them.

REST API Response – JSON to Typedef Example

Supports Nested Objects and Arrays

Optional Fields and Mixed Types Handled

How to Use This JSON to Typedef Converter

More Examples