List pending inbound and outbound app transfers

GET

/v1/app-transfers

const url = 'https://api.aetherpush.com/v1/app-transfers';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Returns pending cross-workspace transfers addressed to or initiated by the current account. Dashboard sessions only.

Authorizations

accessKeyAuth

Responses

200

Pending inbound and outbound transfers.

application/json

object

inbound

required

Pending transfers addressed to the current account.

Array<object>

object

required

string format: uuid

appId

required

string

appName

Present on list responses; may be omitted on create.

string

fromAccountId

required

string

toAccountId

required

string

fromTenantId

required

string format: uuid

toTenantId

required

string format: uuid

fromEmail

Present on list responses; may be omitted on create.

string format: email

toEmail

Present on list responses; may be omitted on create.

string format: email

status

required

string

Allowed values: pending accepted cancelled expired

createdAt

required

string format: date-time

expiresAt

required

string format: date-time

outbound

required

Pending transfers initiated by the current account.

Array<object>

object

required

string format: uuid

appId

required

string

appName

Present on list responses; may be omitted on create.

string

fromAccountId

required

string

toAccountId

required

string

fromTenantId

required

string format: uuid

toTenantId

required

string format: uuid

fromEmail

Present on list responses; may be omitted on create.

string format: email

toEmail

Present on list responses; may be omitted on create.

string format: email

status

required

string

Allowed values: pending accepted cancelled expired

createdAt

required

string format: date-time

expiresAt

required

string format: date-time

Example

{
  "inbound": [
    {
      "status": "pending"
    }
  ],
  "outbound": [
    {
      "status": "pending"
    }
  ]
}

401

Unauthenticated.

application/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"
}

403

API keys and named access keys cannot access this endpoint; a login session is required.

application/json

Error

object

error

required

Human-readable error message.

string

code

required

string

requestId

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

string

Example

{
  "error": "This operation requires a login session. API keys and named access keys cannot access it.",
  "code": "session_required",
  "requestId": "req_abc123"
}

429

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.

application/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
}

Headers

Retry-After

integer

>= 1

Seconds until the tenant window resets.