Ctrlk
ProductsDevelopersAPI ReferenceContact Us
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

List Client

get

List all active clients

Authorizations
OAuth2clientCredentialsOptional
Token URL:
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 · enumOptional

Type of the client

Example: standardPossible values:
Header parameters
AuthorizationstringOptional

JWT token for authentication

Responses
200

200 response

application/json
get/v1/clients
GET /v1/clients?page_size=1&page_number=1 HTTP/1.1
Host: client.api.korewireless.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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"
    }
  ]
}

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
OAuth2clientCredentialsOptional
Token URL:
Header parameters
AuthorizationstringOptional
Body
account_idstringOptional

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.

Responses
201

201 response

application/json
post/v1/clients
POST /v1/clients HTTP/1.1
Host: client.api.korewireless.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "account_id": "acct_012example",
  "name": "Example Client",
  "locked": false,
  "scopes": {
    "products": [
      "SuperSIM"
    ]
  }
}
{
  "message": "text",
  "client_id": "text",
  "client_secret": "text",
  "client_type": "standard",
  "account_id": "acct_012example",
  "name": "text",
  "date_created": "2026-01-01T00:00:00.000Z",
  "client_owner": "text",
  "locked": true
}

Get Client

get

Get Specific Client Details

Authorizations
OAuth2clientCredentialsOptional
Token URL:
Path parameters
client_idstringRequired

Client Identifier to obtain the details

Example: apiclient_01exampledszqr9q
Header parameters
AuthorizationstringOptional
Responses
200

200 response

application/json
get/v1/clients/{client_id}
GET /v1/clients/{client_id} HTTP/1.1
Host: client.api.korewireless.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "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"
  }
}
PreviousPingNextIdentity and Access Management

Last updated

Was this helpful?