Skip to main content

Open API improvements

Pelcro ProductProduct BoardUser/Growth Ideas

🔍 Problem Statement

The Pelcro Open API (Core API) has gaps in endpoint coverage, documentation, and consistency that slow down developer integrations and increase support requests. Several commonly needed operations are either missing or underdocumented.

💡 User Story

As a developer integrating with Pelcro, I want comprehensive, consistent, and well-documented Open API endpoints, so that I can build integrations efficiently without relying on support for undocumented behaviour.

🎯 Definition of Done (DoD)

A feature is done when:

✔️ Given the Open API documentation, when a developer references an endpoint, then the documentation accurately reflects the request/response schema, required parameters, and error codes — and all CRUD operations for core resources are available.

Posted by An Anonymous User ·
Status: Available1 comment

Log in to comment and vote

Comments1

  • mesim

    •

    Jun 10

    This is an issue with both the Open and Core APIs.

    I would like to add 2 points to defenition of done

    • Data returned from Core and Open API should have parity. For example, the Core API should not return a String for a value where the Open API returns an int, and dates/timestamps should be in a consistent format across both APIs.

    • The value type returned should be consistent regardless of the data contained. For example, the Open API user data has a metadata field. When empty, this is of type List<dynamic>, and when there is data, it returns a Map<String, dynamic>. A null value for missing data is acceptable.