Get the organization

GET

/v1/organization

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

• Production

The organization the key belongs to, its plan’s limits and this month’s usage.

Authorizations

• apiKey

Responses

200

The organization.

Media typeapplication/json

An organization with its plan and this month’s usage.

object

id

required

string

object

required

string

Allowed value: organization

name

required

string

plan

required

A plan’s limits.

object

code

required

Stable name (“free”, “pro”…).

string

name

required

The name shown to people.

string

modules

required

The modules it includes (transcoding…).

Array<string>

Allowed values: transcoding live

max_concurrent_jobs

required

How many jobs run at once; the rest wait in queued.

number

monthly_minutes

required

Minutes of video processed a month, counted on the source (or clip); null for unlimited.

number | null

max_upload_bytes

required

The largest source file, in bytes.

number

modules

required

The modules it has: its plan’s, with its own exceptions applied.

Array<string>

Allowed values: transcoding live

webhook_secret

required

The secret webhooks are signed with (whsec_…); only shown to owners and admins in the app, null otherwise.

string | null

usage

required

object

processed_minutes_this_month

required

Minutes of source processed this calendar month (UTC).

number

monthly_minutes

required

The plan’s monthly minutes; null for unlimited.

number | null

average_speed_this_month

required

Seconds of video per second of processing over this month’s finished jobs (30 = 30× real time); null before the first.

number | null

created_at

required

string format: date-time

Example

{
  "object": "organization",
  "plan": {
    "modules": [
      "transcoding"
    ]
  },
  "modules": [
    "transcoding"
  ]
}

401

The API key is missing, invalid or revoked.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

404

It doesn’t exist in your organization.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

429

Too many requests: wait and retry. Answered by the gateway, so the body may differ.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

500

Ours: retry, and tell us if it persists.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}

503

Momentarily unavailable: retry in a few seconds.

Media typeapplication/json

object

error

required

object

code

required

Stable: branch on it.

string

Allowed values: validation_error unauthorized quota_exceeded insufficient_balance forbidden module_not_in_plan organization_suspended not_found conflict too_many_requests internal_error service_unavailable

message

required

English, for people; may change.

string

details

required

Each problem, as path: message (validation errors).

Array<string>

Example

{
  "error": {
    "code": "validation_error"
  }
}