Account

API Authorization

Before you can make requests to this resource, you must have a valid bearer token. Review our API authorization guide to learn how to generate a token. Here's a curl example of how to define your access token in a header:

curl -L "https://iam.api.korewireless.com/v1/accounts" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" 

The examples below do not show the required Authorization header due to a bug. We're working on fixing that. In the meantime, be sure to include that in all of your requests.

Get Platform Account mappings

get

This endpoint retrieves the platform mappings for an account and its child accounts.

Authorizations

Query parameters

account_idstringOptional

The account ID is a unique identifier of your account, which begins with acct_. This optional filter parameter lets you get platforms mapped to a specific account.

Example: acct_xxx

Header parameters

AuthorizationstringOptional

AcceptstringOptional

Content-TypestringOptional

Responses

get

HTTPcURLJavaScriptPython

GET /v1/platform_account_mappings HTTP/1.1
Host: iam.api.korewireless.com
Accept: */*

{
  "platforms": [
    {
      "id": "text",
      "legacy_account_id": "text",
      "platform": "twilio"
    }
  ]
}

Create Child Account

post

This endpoint is used to create a child account.

Authorizations

Header parameters

AuthorizationstringOptional

AcceptstringOptional

Content-TypestringOptional

Body

friendly_namestringRequired

Friendly name of the account

descriptionstringOptional

Brief description of the account

Responses

post

HTTPcURLJavaScriptPython

POST /v1/accounts HTTP/1.1
Host: iam.api.korewireless.com
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "friendly_name": "text",
  "description": "text"
}

{
  "id": "text",
  "parent_id": "text",
  "date_created": "text",
  "friendly_name": "text",
  "status": "ACTIVE"
}

Get All Accounts

get

This endpoint retrieves the information for an account and its child accounts.

Authorizations

Query parameters

account_idstringOptional

The account ID is a unique identifier of your account, which begins with acct_. This optional filter parameter lets you get information for a specific account.

Example: acct_xxx

Header parameters

AuthorizationstringOptional

AcceptstringOptional

Content-TypestringOptional

Responses

get

HTTPcURLJavaScriptPython

GET /v1/accounts HTTP/1.1
Host: iam.api.korewireless.com
Accept: */*

{
  "accounts": [
    {
      "id": "text",
      "parent_id": "text",
      "date_created": "text",
      "friendly_name": "text",
      "status": "ACTIVE"
    }
  ]
}