eComms

Search the documentation

Search every page of the documentation and jump to a result.

Identity

GEThttps://api.e-comms.dev/v1/me
View as Markdown

The organization and permissions this key holds — the simplest way to confirm a key works.

Important

Every call needs a bearer token from an active API key. See Authentication. Create or manage keys from the API keys panel.

Path parameters

None.

Query parameters

None.

Headers

AuthorizationstringRequired

Bearer ek_live_<key>.

Request attributes

None.

Response attributes

organizationobjectRequired

The organization this key belongs to.

Show 2 properties
idstringRequired

This organization's own id.

namestringRequired

This organization's own name.

keyobjectRequired

The key this call was made with.

Show 2 properties
idstringRequired

This key's own id, never the token itself.

namestringRequired

The name you gave it when you created it — never travels with the token.

permissionsstring[]Required

The permissions this key holds, from the one closed set a key can ever request.

Answers with no error code of its own, and costs no quota: confirming that a key works cannot be blocked by the same limit that key is about to hit.