Skip to content
OpenBot

platform.getPlatformOrganizationCredits

GET
/v1/platform/organizations/{organizationId}/credits
curl --request GET \
  --url https://example.com/v1/platform/organizations/example/credits \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organizationId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
enabled
required
boolean
balanceMicros
required
integer
>= -9007199254740991 <= 9007199254740991
grants
required
Array<object>
object
id
required
string
amountMicros
required
integer
>= -9007199254740991 <= 9007199254740991
note
required
string
createdBy
required
string
createdAt
required
string

Example generated

{
  "enabled": true,
  "balanceMicros": 1,
  "grants": [
    {
      "id": "example",
      "amountMicros": 1,
      "note": "example",
      "createdBy": "example",
      "createdAt": "example"
    }
  ]
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example 

{
  "_tag": "Forbidden"
}

404

Section titled “404”

OrganizationNotFound

Media typeapplication/json
object
_tag
required
string
Allowed values: OrganizationNotFound
organizationId
required
string

Example 

{
  "_tag": "OrganizationNotFound"
}

409

Section titled “409”

@nmnmcc/ability/Authorizer/Pending

Media typeapplication/json
object
_tag
required
string
Allowed values: Pending
ticket
required
string
reason
string

Example 

{
  "_tag": "Pending"
}

503

Section titled “503”

PlatformUnavailable | OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PlatformUnavailable

Example 

{
  "_tag": "PlatformUnavailable"
}