Skip to main content
GET
/
access-key
curl -X GET "https://config.gms.ensync.cloud/v1/access-key?pageIndex=0&limit=10&order=DESC&orderBy=createdAt" \
  -H "X-API-KEY: your-api-key"

{
  "resultsLength": 2,
  "results": [
    {
      "id": 1,
      "name": "Production Key",
      "key": "ensk_prod_xxxxx",
      "type": "SERVICE",
      "permissions": {
        "send": ["order/*"],
        "receive": ["payment/*"]
      },
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ]
}

​
Query Parameters

​
accessKey
string
The key to filter
​
pageIndex
integer
required
Page index (minimum: 0)
​
limit
integer
required
Number of results per page (1-100)
​
order
string
required
Sort order: ASC, DESC, asc, or desc
​
orderBy
string
required
Field to sort by: name or createdAt

​
Response

​
resultsLength
integer
Number of results returned
​
results
array
Array of access key objects
curl -X GET "https://config.gms.ensync.cloud/v1/access-key?pageIndex=0&limit=10&order=DESC&orderBy=createdAt" \
  -H "X-API-KEY: your-api-key"

{
  "resultsLength": 2,
  "results": [
    {
      "id": 1,
      "name": "Production Key",
      "key": "ensk_prod_xxxxx",
      "type": "SERVICE",
      "permissions": {
        "send": ["order/*"],
        "receive": ["payment/*"]
      },
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ]
}