Skip to content

Update defaults and add info regarding the truncation header #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rodrigosoares merged 2 commits into from
Jun 27, 2025
Merged

Update defaults and add info regarding the truncation header #33

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3878d89
Update defaults and add info regarding the truncation header
rodrigosoares Jun 26, 2025
b360ce4
Fix header
rodrigosoares Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions source/rest-v2.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ API keys are passed via the `Authorization` header as demonstrated in the code s
Many endpoints in the API support pagination to help manage large result sets. When using pagination, the following query parameters are available:

| Parameter | Type | Description |
| --------- | ------- | ------------------------------------------------------ |
| --------- | ------- |--------------------------------------------------------|
| page | Integer | Page number to retrieve (default: returns all results) |
| per_page | Integer | Number of items per page (default: 25, max: 100) |
| per_page | Integer | Number of items per page (default: 1000, max: 1000) |

When pagination is used, the following headers are included in the response:

Expand All @@ -46,6 +46,12 @@ When pagination is used, the following headers are included in the response:
| X-Next-Page | Next page number (if available) |
| X-Prev-Page | Previous page number (if available) |

If no pagination parameters are provided, the API will return all results in a single response, up to a maximum of 1000 items, and include the following header in the response:

| Header | Description |
|--------------------|--------------------------------------------------------------|
| X-Result-Truncated | Set to `true` if there are more items than the maximum allowed |

### API Path structure

The base path of an API request is: `https://api.publitas.com/v2/`
Expand Down