API | Enhancement | Add bulk fetch payload specifications to openapi.yaml - #98
Open
Namasivaayam-L wants to merge 1 commit into
Open
API | Enhancement | Add bulk fetch payload specifications to openapi.yaml#98Namasivaayam-L wants to merge 1 commit into
Namasivaayam-L wants to merge 1 commit into
Conversation
This was referenced Aug 7, 2026
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
API documentation for #36
Add POST /v1/spaces/{space_id}/objects/batch endpoint for fetching multiple objects by their IDs in a single request.
Adds BatchGetObjectsRequest schema with required
idsarray (min 1, max 100).Description
This PR adds OpenAPI documentation for a batch object fetch endpoint. It allows a client to retrieve multiple objects by ID within a space in one request, avoiding N sequential GET calls when operating on a known set of objects (e.g., a list of tasks or commitments). Unfound IDs are represented by
nullentries, preserving the order of the requested IDs.Changes:
POST /v1/spaces/{space_id}/objects/batchendpoint documentation (operationIdget_objects_batch, tagObjects)apimodel.BatchGetObjectsRequestschema definition (idsarray, min 1 / max 100)ObjectResponseornull; 400 / 401 / 429 / 500 error responsesdocs/reference/2025-11-08/get-objects-batch.*)get-objects-batchentry to the Objects category insidebar.tsWhat type of PR is this? (check all applicable)
Related Tickets & Documents
Mobile & Desktop Screenshots/Recordings
N/A - OpenAPI specification and documentation update only.
Example usage:
curl -X POST http://localhost:31009/v1/spaces/{space_id}/objects/batch \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Anytype-Version: 2025-11-08" \ -H "Content-Type: application/json" \ -d '{"ids": ["<object_id_1>", "<object_id_2>"]}'Example response:
[ { "id": "bafyreid1...", "name": "Task A", ... }, null ]Verification:
bun run lintpassesbun run build(Docusaurus production build) succeeds$ref/constraints verified