List api key

GET

https://api.sureshake.com/v2/api-keys

Query parameters

limit
optional
number
maximum: 100 · minimum: 1 · default: 20

offset
optional
number
minimum: 0 · default: 0
includeInactive
optional
boolean
default: false

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  minLength: 1
- name
  string
  required
- prefix
  string
  required
- permissions
  array of
  read
  or
  write
  or
  admin
  required
- usageCount
  number
  required
  minimum: 0
- createdAt
  string
  required
  format: date-time
- status
  string
  required
- description
  optional
  string
  or null
- lastUsedAt
  optional
  string
  or null
  format: date-time
- expiresAt
  optional
  string
  or null
  format: date-time
- capabilities
  optional
  array of
  entities.ingest
  or
  entities.enrich
  or
  entities.profile.read
  or
  entities.profile.propose
  or
  entities.profile.review
  or
  entities.identity.resolve
  +13 more
  default: []
- rateLimit
  optional
  number
  or null
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

List api key

curl --request GET \
  --url https://api.sureshake.com/v2/api-keys

const url = 'https://api.sureshake.com/v2/api-keys';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "prefix": "string",
      "lastUsedAt": "2019-08-24T14:15:22Z",
      "expiresAt": "2019-08-24T14:15:22Z",
      "permissions": [
        "read"
      ],
      "capabilities": [],
      "rateLimit": 0,
      "usageCount": 0,
      "createdAt": "2019-08-24T14:15:22Z",
      "status": "string"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "hasMore": true,
    "page": 0,
    "totalPages": 0
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}