Skip to content

Get the current authenticated account

GET
/v1/account
curl --request GET \
--url https://api.aetherpush.com/v1/account \
--header 'Authorization: Bearer <token>'

Returns the account profile of the authenticated user. The linkedProviders field is always an empty array in Aether (legacy Microsoft fork field, scheduled for removal).

Account profile.

Media typeapplication/json
object
account
required
object
email
required
string format: email
name
required
string
<= 255 characters
linkedProviders
required

Legacy field inherited from the Microsoft CodePush fork. Always empty in Aether. Will be removed in a future version.

Array<string>
deletionScheduledFor
required

When the account will be purged, in epoch milliseconds, after a POST /v1/account/deletion; null otherwise. While it is set, every authenticated operation other than this one, the cancel route, DELETE /v1/sessions/current and GET /v1/authenticated answers 403.

integer | null format: int64
staff

Present only on the response of an Aether staff account, and only while that account meets the conditions for internal support access. Its absence is the normal case for every customer account and carries no other meaning. The operations it refers to are internal and are not part of this API, so the field is informational for every client of this endpoint. Error codes those operations can answer with are omitted from ApiErrorCode for the same reason.

object
role
required
string
Allowed values: support_viewer super_admin

Example

{
"account": {
"email": "adrian@aetherpush.com",
"name": "Adrian Moreno",
"linkedProviders": [],
"deletionScheduledFor": null
}
}

Unauthenticated.

Media typeapplication/json
Error

Standard error envelope. code is the stable machine identifier for client branching and i18n. The wording of error is a human-readable fallback and is not part of the contract. Specialized responses keep narrower code enums where clients already branch on them.

object
error
required

Human-readable error message.

string
code
required

Stable machine code. Prefer this over matching on error. The values this API can answer with are listed in the ApiErrorCode schema of the raw document at https://api.aetherpush.com/openapi.yaml. The field stays an open string here so that a release adding a value does not invalidate this response.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
"error": "The requested resource was not found.",
"code": "not_found",
"requestId": "req_abc123"
}

The API key’s scopes do not grant read, which answers required_scopes. A refusal raised before the route is reached, such as a request that did not arrive through the trusted edge, answers a plain error instead.

Media typeapplication/json
One of:
Error

Standard error envelope. code is the stable machine identifier for client branching and i18n. The wording of error is a human-readable fallback and is not part of the contract. Specialized responses keep narrower code enums where clients already branch on them.

object
error
required

Human-readable error message.

string
code
required

Stable machine code. Prefer this over matching on error. The values this API can answer with are listed in the ApiErrorCode schema of the raw document at https://api.aetherpush.com/openapi.yaml. The field stays an open string here so that a release adding a value does not invalidate this response.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Examples

The API key's scopes do not grant read

{
"error": "Insufficient permissions",
"code": "insufficient_scopes",
"required_scopes": [
"read"
],
"requestId": "req_abc123"
}

The tenant’s per-minute management API budget is spent. Retry-After and X-RateLimit-* say when to retry. This is not a plan quota: quota 429s use the Error envelope and do not set Retry-After.

Media typeapplication/json
RateLimitError

Returned with HTTP 429 when an endpoint-specific rate limit is hit, including the per-tenant management API budget. Not the process-wide address limiter (see GlobalAddressRateLimitErrorResponse). retryAfterSeconds indicates how long the client should wait before retrying, and matches the Retry-After header when that header is set. code names the limit that fired so clients can translate without matching on error.

object
error
required
string
code
required
string
retryAfterSeconds
required
integer
>= 1
requestId
string

Example

{
"error": "Rate limit exceeded",
"code": "tenant_rate_limit_exceeded",
"retryAfterSeconds": 60
}
Retry-After
integer
>= 1

Seconds until the tenant window resets.

Internal server error.

Media typeapplication/json
Error

Standard error envelope. code is the stable machine identifier for client branching and i18n. The wording of error is a human-readable fallback and is not part of the contract. Specialized responses keep narrower code enums where clients already branch on them.

object
error
required

Human-readable error message.

string
code
required

Stable machine code. Prefer this over matching on error. The values this API can answer with are listed in the ApiErrorCode schema of the raw document at https://api.aetherpush.com/openapi.yaml. The field stays an open string here so that a release adding a value does not invalidate this response.

string
requestId

Unique identifier for the request, also exposed as the X-Request-Id response header.

string

Example

{
"error": "The requested resource was not found.",
"code": "not_found",
"requestId": "req_abc123"
}