List Credentials

GET/v5/credentials

Retrieve a paginated list of all credentials for the current account with optional name filtering.

Query ParametersExpand Collapse

ending_before: optional string

limit: optional number

maximum10000

minimum1

name: optional string

Filter credentials by name

sort_by: optional string

sort_order: optional SortOrder

One of the following:

"asc"

"desc"

starting_after: optional string

ReturnsExpand Collapse

has_more: boolean

Whether there are more items left to be fetched.

items: array of Credential { id, created_at, created_by_identity_type, 7 more }

id: string

created_at: string

formatdate-time

created_by_identity_type: string

created_by_user_id: string

credential_metadata: map[unknown]

description: string

name: string

type: string

updated_at: string

formatdate-time

object: optional string

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: optional number

The maximum number of items to return.

object: optional "list"

List Credentials

curl https://api.egp.scale.com/v5/credentials \
    -H "x-api-key: $SGP_API_KEY"

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_identity_type": "created_by_identity_type",
      "created_by_user_id": "created_by_user_id",
      "credential_metadata": {
        "foo": "bar"
      },
      "description": "description",
      "name": "name",
      "type": "type",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "object": "object"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Returns Examples

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by_identity_type": "created_by_identity_type",
      "created_by_user_id": "created_by_user_id",
      "credential_metadata": {
        "foo": "bar"
      },
      "description": "description",
      "name": "name",
      "type": "type",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "object": "object"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}