Skip to main content
GET
/
credentials
List credentials
curl --request GET \
  --url https://api.deck.co/v2/credentials \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "object": "<string>",
      "status": "<string>",
      "external_id": "<string>",
      "source_id": "<string>",
      "auth_method": "<string>",
      "auth_credentials": {
        "username": "<string>",
        "key": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Query Parameters

Limit

Maximum number of items to return (1-100, default 20)

starting_after
string

Cursor for forward pagination. Pass the ID of the last item from the previous page.

ending_before
string

Cursor for backward pagination. Pass the ID of the first item from the previous page.

source_id
string[]

Unique identifier for the source (prefixed with src_).

status
string[]

Filter by credential status: unverified, verified, invalid, deleted.

external_id
string

Filter by the external ID assigned when creating the credential.

Response

OK

data
object[]

Array of resource objects for the current page.

has_more
boolean

true if there are more results beyond this page.

next_cursor
null | string

Opaque cursor string to pass as the cursor query parameter on the next request. null when there are no more pages.

request_id
null | string

Unique identifier for the API request.