Organization and key

Find out which organization and API key a request is authenticated as.

GET/v1/me

Authentication

Any active API key can call GET /v1/me. No additional scope is required. The endpoint takes no request body or query parameters.

Use this endpoint to confirm a key’s organization, scopes and test/live mode before connecting an integration. It never returns the full secret key.

Response

Field	Type	Meaning
`org.id`	string	Organization UUID.
`org.name`	string	Organization display name.
`org.slug`	string	Organization slug used in console routes.
`key.id`	string	API key UUID.
`key.name`	string	Name given to the key by its creator.
`key.prefix`	string	Display prefix, not a usable credential.
`key.scopes`	string array	Granted scopes.
`key.test`	boolean	Whether email submissions are validation-only.

Errors

Account endpoints use { "error": { "code": "...", "message": "..." } }, not Postmark’s ErrorCode shape.

HTTP 401 means unauthorized, HTTP 403 means org_suspended, and HTTP 429 means rate_limited. Read Errors for recovery steps.

const response = await fetch( 'https://api.prawnwire.com/v1/me', { method: 'GET', headers: { Authorization: 'Bearer ' + process.env.PRAWNWIRE_API_KEY, }, }, ) const result = await response.json() if (!response.ok) throw new Error(JSON.stringify(result)) console.log(result)

{ "org": { "id": "d3dc22a4-0f91-45ee-8c03-a74126b861ea", "name": "Example organization", "slug": "example" }, "key": { "id": "fb85a0d7-c24c-4841-8bad-719b858de61f", "name": "Application", "prefix": "pw_live_…", "scopes": [ "email:send" ], "test": false } }

Organization and key.

Authentication

Response

Errors

Organization and key