Kobble
  1. Clients
Kobble
  • Introduction
  • Authorization
    • Authorization
    • Get access token
      POST
  • Beneficiaries
    • List all beneficiaries
      GET
    • Get beneficiary by ID
      GET
    • Create beneficiary
      POST
    • Update beneficiary
      PUT
  • Cards
    • Cards API
    • Get all cards
      GET
    • Create a new card
      POST
    • Get card by ID
      GET
    • Update card status
      PATCH
    • Replace or renew card
      POST
    • Generate card secret
      POST
  • Card Programs
    • Card Programs API
    • Get all programs
      GET
    • Create a new program
      POST
    • Get program by ID
      GET
  • Clients
    • Clients API
    • Get all clients
      GET
    • Get client by ID
      GET
    • Create a new client
      POST
    • Update client status
      PATCH
  • Endusers
    • Endusers API
    • Get all endusers
      GET
    • Create a new enduser
      POST
    • Get enduser by ID
      GET
  • Transactions
    • Transactions API
    • Get all transactions
    • Create a transaction
    • Get transaction by ID
    • Create manual credit transaction
    • Create manual debit transaction
  • Wallets
    • Wallets API
    • Get all wallets
    • Create a new wallet
    • Get wallet by ID
    • Update wallet
  • Relays
    • Relays API
    • Create subscription
  • Webhooks
    • Webhooks API
    • Get all webhooks
    • Create a webhook
    • Delete a webhook
  1. Clients

Get all clients

GET
/customers/v1/clients
Clients
Retrieve all clients

Request

Header Params
Authorization
string 
required
Example:
Bearer {{access_token}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/customers/v1/clients' \
--header 'Authorization: Bearer {{access_token}}'

Responses

🟢200Success
application/json
Body
id
string <uuid>
required
The unique identifier of the client.
name
string 
required
The name of the client.
email
string <email>
required
The email address of the client.
status
enum<string> 
required
The current status of the client.
Allowed values:
INACTIVEACTIVE
created_at
string <date-time>
required
The date and time the client was created.
updated_at
string <date-time>
required
The date and time the client was last updated.
metadata
object 
required
Metadata specific to the client.
Example
{
    "id": "50e748c1-ebf9-449c-ab3f-2744323753d3",
    "name": "Ms. Terry Olson",
    "email": "Zoila.Murphy@yahoo.com",
    "status": "INACTIVE",
    "created_at": "2025-01-14T16:31:18.487Z",
    "updated_at": "2025-01-14T16:31:18.488Z",
    "metadata": {}
}
Previous
Clients API
Next
Get client by ID
Built with