Get Account

GET /v1/accounts/{account_id}

Get Account

cURL

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "email": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "accountType": "ACCOUNT_TYPE_UNSPECIFIED",
  "state": "STATE_UNSPECIFIED",
  "status": {
    "code": "OK",
    "message": "<string>"
  },
  "suspendState": "UNSUSPENDED",
  "updateTime": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id · string · required

The Account Id

Query Parameters

readMask · string

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

200 - application/json

A successful response.

email · string · required

The primary email for the account. This is used for billing invoices and account notifications.

name · string

displayName · string

Human-readable display name of the account. e.g. "My Account" Must be fewer than 64 characters long.

createTime · string<date-time>

The creation time of the account.

accountType · enum<string> · default: ACCOUNT_TYPE_UNSPECIFIED

The type of the account.

Available options: ACCOUNT_TYPE_UNSPECIFIED, ENTERPRISE

state · enum<string> · default: STATE_UNSPECIFIED

The state of the account.

Available options: STATE_UNSPECIFIED, CREATING, READY, UPDATING, DELETING

status · Mimics [https://github.com/googleapis/googleapis/blob/master/google/rpc/status.proto] · object

Contains information about the account status.

Show child attributes

suspendState · enum<string> · default: UNSUSPENDED

Available options: UNSUSPENDED, FAILED_PAYMENTS, CREDIT_DEPLETED, MONTHLY_SPEND_LIMIT_EXCEEDED, BLOCKED_BY_ABUSE_RULE

updateTime · string<date-time>

The update time for the account.