Get Client Configuration

Request

Path Params

clientId

string

required

the client id

Query Params

pageSize

integer

optional

page size - int64

pageOffset

integer

optional

page offset- int64

sortField

string

optional

field to sort by - string

sortDirection

enum<string>

optional

Allowed values:

ASCDESC

mode

string

optional

the environment mode

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api-gateway-uat.mmacs.io/platform/client-service/api/v1//client-configurations?pageSize&pageOffset&sortField&sortDirection&mode'

Responses

🟢200OK

application/json

success response

Body

ClientConfigOutput type

data

object (ClientConfigOutputData)

optional

the response data object

id

number

optional

The id of the client

entityId

string

optional

The entity ID of the client (nanoid)

createdAt

string

optional

The date the entity was created

updatedAt

string

optional

The last date the entity was updated

createdBy

string

optional

The email of the user who created the entity

updatedBy

string

optional

The email of the user who last updated the entity

isDeleted

string

optional

Check if the entity has been deleted (soft delete)

mode

enum<string>

required

Allowed values:

livesandbox

clientId

string

required

The client Id

callbackUrl

string

optional

Client's callback URL

webhookUrl

string

optional

Client's webhook URL

ipAddresses

array[string]

optional

List of ip adddresses to whitelist

Example

{
  "data": {
    "id": 0,
    "entityId": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "createdBy": "string",
    "updatedBy": "string",
    "isDeleted": "string",
    "mode": "live",
    "clientId": "string",
    "callbackUrl": "string",
    "webhookUrl": "string",
    "ipAddresses": [
      "string"
    ]
  }
}

🟠400Bad Request

🟠401Unauthorized