# API configuration
General settings for API calls can be set in the ./config/api.js
file:
Property | Description | Type | Default |
---|---|---|---|
responses | Global API response configuration | Object | - |
responses.privateAttributes | Set of globally defined attributes to be treated as private. | String array | [] |
rest | REST API configuration | Object | - |
rest.defaultLimit | Default limit parameter used in API calls (see REST API documentation) | Integer | 25 |
rest.maxLimit | Maximum allowed number that can be requested as limit (see REST API documentation).Defaults to null , which fetches all results. | Integer | 100 |
Example:
// path: ./config/api.js
module.exports = ({ env }) => ({
responses: {
privateAttributes: ['_v', 'id', 'created_at'],
},
rest: {
defaultLimit: 100,
maxLimit: 250,
},
});