v1

latestOpenAPI 3.1.02026-07-24270180.3 KB

Query a gateway service

Search for a specific or all gateway services on your PowerBoard account.

get/v1/gateways/{id}

Path parameters

idstring required

The id of the gateway to be queried. Omitting this will return a list of all gateways

Query parameters

skipstring

Pagination parameter to skip first n transactions from list, default = 0

limitstring

Pagination parameter to limit output to n , default = 100 , maximum value = 1000

sortkeystring

Sorting key parameter i.e. created_at

sortdirectionstring

Sorting order direction parameter ASC or DESC

searchstring

Any word or phrase to be searched

Headers

x-user-secret-keystring required

Your API private/secret key. This can be found in the powerboard dashboard.

Content-Typestring required

This will always be application/json

Response

200

statusinteger

{"stackTrail":"paths:/v1/gateways/{id}:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "status": 200,
  "resource": {
    "type": "gateways",
    "data": [
      {
        "created_at": "2020-05-25T13:55:40.161Z",
        "updated_at": "2020-05-25T13:55:41.383Z",
        "type": "MPGS",
        "name": "MPGS",
        "_id": "5ecbce5cb12c99579e470096",
        "mode": "test"
      }
    ],
    "limit": 100,
    "sortkey": "created_at",
    "sortdirection": "DESC",
    "count": 1
  }
}