API Response Naming Conventions: A Comprehensive Guide
4 min read
Consistent field naming in API responses reduces confusion and makes your API intuitive for consumers.
Common Patterns
| Field Type | Pattern | Examples |
|---|---|---|
| ID | resource + Id/id | userId, orderId |
| Timestamp | verb + At/at | createdAt, updatedAt |
| Boolean | is/has + adjective | isActive, hasVerified |
| Count | noun + Count | itemCount, pageCount |
| URL | noun + Url | avatarUrl, websiteUrl |
Pagination
{ "data": [...], "pagination": { "page": 1, "pageSize": 20, "totalCount": 100, "totalPages": 5 } }Convert
camelCase or snake_case JSON key converter.