Get Client Application

GET 
/api/client-applications/:clientApplicationId

Get Client Application

Request

Path Parameters

clientApplicationId stringrequired
Id of the client application.
Example: 65a7e8ef0d230d0a6bf755e07d39eb02

Responses

200

application/json

Schema

Schema

id string

The client application id.

accountId string

The partner account id that is affiliated with the client application.

allowedOrigins string[]

The allowed origins for the client application.

createdAt string

Timestamp of client application creation.

modifiedAt string

Timestamp of modification.

Example (from schema)

{
  "id": "65a7e8ef0d230d0a6bf755e07d39eb02",
  "accountId": "225d85e65495722bf6517ea0ba0d6f56",
  "allowedOrigins": [
    [
      "https://develop-app.com",
      "http://localhost:3000"
    ]
  ],
  "createdAt": "2022-11-16T03:13:18.142Z",
  "modifiedAt": "2022-11-16T03:13:18.142Z"
}

400

Request parameters are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired

errors

object[]

Array [

message string

path string

The location of the invalid path param, query param or payload attribute.

]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

403

Subject is not allowed to perform the action with the reason stated in the errorCode

FORBIDDEN Resource does not exist or there are no sufficient permissions to perform the action.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...