---
title: "Get credentials"
method: GET
path: "/credentials"
tags: ["Credentials"]
---

# Get credentials

`GET /credentials`

## Request

- Base URL: `https://env.unqork.io/api/1.0`
- URL: `https://env.unqork.io/api/1.0/credentials`
- Auth: OAuth 2
  - Client credentials
  - Password
  - Token URL: `https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token`
- TypeScript: <https://skmtc.dev/unqork/apis/unqork-customer-api/docs/credentials/get.ts> (a function with typed inputs; its response is checked against the schema)

Get credentials.
### Authorization Required:
  - Designer Administrator

## Query parameters

- `limit` integer
- `sort` string
- `offset` integer
- `sortOrder` integer
- `filter` string

## Response `200`

Array containing JSON objects of each found credential

- CredentialResponse[]
  - `clientId` string, required: Client ID of the credential.
  - `name` string, required: Name of the credential.
  - `role` string, required: Express role of the credential.
  - `roles` string[], required: Creator or Express roles of the credential.
  - `groups` string[]: Express groups of the credential.
  - `applicationRoles` object: Application Express roles of the credential.
  - `created` string, required: Date of when the credential was created.
  - `modified` string: Date of when the credential was modified.
  - `status` string, required: Status of the credential.
  - `credentialType` string, required: Type of the credential (Creator or Express).
  - `expireDate` string: Date of when the credential expires.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/unqork/apis/unqork-customer-api.md) - [All operations](https://skmtc.dev/unqork/apis/unqork-customer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/unqork/apis/unqork-customer-api/revisions/13dad4096373?raw)