The CharmVerse public API requires an API key linked to your space, or a partner API key allowing access to multiple spaces. You can request this on our Discord server

Your API key should be passed in the request headers as Authorization: "Bearer <your-api-key>". You can make requests related to cards or databases using the UUID id or the page path ie. "page-022345334" which is visible in the URL when the card or database is open as a full page.

We provide a Postman collection for you test out requests while build your integration. Make sure the target database you make requests against contains the properties you wish to use as custom properties in your request. You will need to setup Postman with an API_KEY and API_URL environment variable. The API_URL can be taken from the servers list in this documentation. The API_KEY will be the one you receive after requesting it from us.

⚠️ If you are using a multi-space partner API key, any requests to API endpoints in the Space API category should also contain the spaceId you wish to make the request for as part of the query. Example:"/api/v1/endpoint?spaceId=fc59c720-40de-bc1a-8b2b-00538f02953c"