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_idstring

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

Authorizationstring

Acceptstring

Content-Typestring

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://iam.api.korewireless.com/v1/platform_account_mappings'

200

400

401

403

404

409

422

500

503

200

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

200 response

Create Child Account

post

This endpoint is used to create a child account.

Authorizations

Header parameters

Authorizationstring

Acceptstring

Content-Typestring

Body

friendly_namestringrequired

Friendly name of the account

descriptionstring

Brief description of the account

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://iam.api.korewireless.com/v1/accounts' \
  --header 'Content-Type: application/json' \
  --data '{
    "friendly_name": "text",
    "description": "text"
  }'

200

400

401

403

404

409

422

500

503

200

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

200 response

Get All Accounts

get

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

Authorizations

Query parameters

account_idstring

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

Authorizationstring

Acceptstring

Content-Typestring

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://iam.api.korewireless.com/v1/accounts'

200

400

401

403

404

409

422

500

503

200

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

200 response