Clients

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://client.api.korewireless.com/v1/ping" -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.

PreviousPing NextIdentity and Access Management

Last updated 25 days ago

Was this helpful?

List Client

get

List all active clients

Authorizations

Query parameters

page_sizeinteger · int32 · min: 1required

Enter the number of items you want to view per page.

Example: 10

page_numberinteger · int32 · min: 1required

Input the page number you wish to navigate to.

Example: 1

client_typestring · enum

Type of the client

Example: standard

Options: admin, standard

Header parameters

Authorizationstring

JWT token for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://client.api.korewireless.com/v1/clients?page_size=1&page_number=1'

200

400

401

403

404

500

502

503

504

{
  "meta": {
    "count": 1,
    "page_number": 1,
    "page_size": 10,
    "previous_page_url": "url",
    "next_page_url": "url"
  },
  "clients": [
    {
      "client_id": "apiclient_01exampledszqr9q",
      "account_id": "acct_012example",
      "name": "Test client",
      "client_owner": "test@acme.com",
      "client_type": "standard",
      "locked": true,
      "date_created": "Fri, 05 Apr 2024 11:08:14 GMT"
    }
  ]
}

200 response

Create Client

post

Create a new API client for the account for which the API credentials are for. Once created, the client ID and secret will be shown, the latter only shown once during the creation process.

Authorizations

Header parameters

Authorizationstring

Body

account_idstring

ID of the account the client belongs to. Defaults to the clientCred's account scope if not specified.

Example: acct_012example

namestringrequired

Name of the client.

lockedbooleanrequired

Specifies whether the client is locked or not. Can be true, false, or null.

scopesobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://client.api.korewireless.com/v1/clients' \
  --header 'Content-Type: application/json' \
  --data '{
    "account_id": "acct_012example",
    "name": "Example Client",
    "locked": false,
    "scopes": {
      "products": [
        "SuperSIM"
      ]
    }
  }'

201

400

401

403

404

500

502

503

504

{
  "message": "text",
  "client_id": "text",
  "client_secret": "text",
  "client_type": "standard",
  "account_id": "acct_012example",
  "name": "text",
  "date_created": "2025-03-17T10:10:02.603Z",
  "client_owner": "text",
  "locked": true
}

201 response

Get Client

get

Get Specific Client Details

Authorizations

Path parameters

client_idstringrequired

Client Identifier to obtain the details

Example: apiclient_01exampledszqr9q

Header parameters

Authorizationstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://client.api.korewireless.com/v1/clients/{client_id}'

200

400

401

403

404

500

502

503

504

{
  "client": {
    "client_id": "apiclient_01exampledszqr9q",
    "account_id": "acct_012example",
    "name": "Test client",
    "client_owner": "test@acme.com",
    "client_type": "standard",
    "locked": true,
    "date_created": "Fri, 05 Apr 2024 11:08:14 GMT"
  }
}

200 response

API Authorization

API Authorization

List Client

Create Client

Show child attributes

Get Client