Skip to content

API endpoint for retrieving project information #271

@julianwitzel

Description

@julianwitzel

Feature Request: API endpoint for retrieving project information (/projects)

Hi Plunk team 👋

At the moment, there doesn’t seem to be an API endpoint that allows retrieving metadata about a project. For certain integrations and automation use cases, having access to project-level information via the API would be very useful.

Proposed solution

Introduce an endpoint such as:

GET /projects

or optionally:

GET /projects/{projectId}

Example use cases

  • Programmatically retrieving the project name
  • Accessing the configured default sender domain
  • Verifying project configuration in multi-project setups
  • Reducing manual configuration and hard-coded values in integrations

Example response (illustrative)

{
  "id": "proj_123",
  "name": "My Project",
  "defaultSenderDomain": "example.com",
  "createdAt": "2024-01-01T12:00:00Z"
}

Happy to provide more details or discuss the requirements if helpful.
Thanks for considering this feature!

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions