REST & GraphQL API Parameters Markdown Table Template
Document REST endpoints, GraphQL query fields, request payload types, requirements, and default fallback values.
Interactive Template Customizer
Edit cells, add rows, or sort — changes update the markdown liveColumn Architecture & Alignment Specification
Carefully chosen column alignments ensure optimal visual scannability across desktop and mobile screens:
| Column Header | Alignment | Delimiter Syntax | Design Rationale |
|---|---|---|---|
| Parameter | left | :--- | Standard left-aligned readable text & descriptions |
| Type | center | :---: | Centers compact status symbols, flags, or tags |
| Required | center | :---: | Centers compact status symbols, flags, or tags |
| Description | left | :--- | Standard left-aligned readable text & descriptions |
| Default | right | ---: | Aligns numeric scale, defaults, or magnitudes |
Pro Tips for REST & GraphQL API Parameters
- Wrap parameter names and sample defaults in backticks (`page`) for clear monospace rendering.
- Use right alignment for numeric defaults and center alignment for boolean/required flags.
- For complex JSON nested keys, use dot-notation (e.g. `user.profile.id`).
How to Deploy This Table Across Platforms
Paste raw Markdown into README.md. Leave one blank newline above and below for GFM compliance.
Paste directly into Live Preview mode. Use wikilinks ([[Note]]) inside cells for bidirectional linking.
Press Enter to make a fresh empty line block, then paste. Notion auto-transforms it into a native Simple Table block.
Standard GFM tables work out of the box in modern MDX engines. You can style them via custom CSS selectors.
Raw GFM Code
| Parameter | Type | Required | Description | Default |
| :-------- | :-----: | :------: | :-------------------------------------------------- | -------------: |
| `page` | integer | No | Page offset for paginated record retrieval | `1` |
| `limit` | integer | No | Maximum records returned per response (max: 100) | `50` |
| `sort_by` | string | No | Field to sort results by (`created_at`, `name`) | `"created_at"` |
| `filter` | string | No | Filter expression for search narrowing | `null` |
| `api_key` | string | Yes | Bearer token passed in Authorization request header | — |Standard padded style with boundary pipes matching GitHub GFM parser specifications.
Platform Support
Syntax Formatting Rules
- Pipe Escaping: Use
\|for text with pipe symbols. - Multi-line Cells: Use
<br>for line breaks. - Monospace Text: Wrap variables or code in backticks (
`key`). - Empty Values: Use
—instead of leaving cells empty.
More Developer Markdown Templates
Browse all 50 templatesEnvironment Variables (.env) Matrix
Document required and optional environment keys, secret classifications, types, and staging vs production defaults.
CLI Options & Arguments Reference
Reference table for command-line tool options, shorthand aliases, data types, environment overrides, and descriptions.
Docker Container Ports & Volumes Matrix
Map container service names, host ports, guest ports, protocols, volume bindings, and persistence scopes.
Frequently Asked Questions About REST & GraphQL API Parameters
How should I format parameters, flags, or keys in this REST & GraphQL API Parameters table?
Wrap variable names in the "Parameter" column in backticks (e.g., `page`). This enforces monospace rendering, prevents underscores from italicizing surrounding text, and improves readability across GitHub and developer documentation sites.
Where in my repository or project documentation should I place this REST & GraphQL API Parameters table?
This template is specifically designed for place in open-source repository readmes, api reference guides, and developer portal documentation. Place it inside your project's README.md, technical wiki, or developer portal. Always leave at least one blank newline before and after the table to ensure the GFM parser detects it properly.
Why is the "Parameter" column styled with left alignment?
The "Parameter" column functions as the primary key of this table. Setting it to left alignment establishes an anchor along the left reading margin, making it effortless for developers to scan down the list.
How do I add line breaks inside a single cell of this REST & GraphQL API Parameters table?
Standard Markdown table rows cannot contain literal carriage returns. To create a multi-line list inside a cell, insert HTML <br> tags (e.g. "Item 1<br>Item 2<br>Item 3"). This keeps the entire entry in a single clean row without breaking column alignments.
How do I handle optional or missing values in REST & GraphQL API Parameters?
Never leave table cells completely empty, as some strict Markdown parsers may collapse empty pipes. Instead, insert an em-dash ("—"), "N/A", or "None" to explicitly indicate that a value is not applicable.
Can I export this REST & GraphQL API Parameters table into CSV, Excel, or HTML?
Yes. In the interactive toolkit above, you can edit your data and use our integrated export tools to convert this table directly into CSV, JSON, HTML <table>, or LaTeX with a single click.