Project

Get the project

The project behind the API key: one app, with its own numbers, one assistant, its calls and its webhooks. verification lists the four verification levels with what each still needs and what it unlocks. access says whether this key or connection is limited to some sites and apps (an owner or admin sets that in the portal); a limited key gets only id, name, edition, created_at, mode and access.

get/project

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/project
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: project:read)

Response

The project.

idstring uuid required

The id of the project.

namestring required

The name of the project. The assistant uses it in its greeting.

editionstring required

Always api for a project of the Hypamoon API.

created_atstring date-time required

When the project was created.

spending_limit_eurnumber nullable

The most the project can spend per month, in euros. Null in test mode: a test project costs nothing. Left out for a key or connection limited to some sites and apps.

numbers_countinteger

How many numbers the project has. Left out for a limited key or connection.

mode'live' | 'test' required

live or test: the mode of the key, which is always the mode of its project.

live_project_idstring uuid nullable

Only in test mode: the live project this test project belongs to, or the project itself when it has no separate test project.

Changes

No recorded changes to this operation across all 1 revision of this API.