logo

Retrieve credentials

Retrieves a list of authentication credentials.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

Responses
200

List of authentication credentials retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
username
required
string

Username associated with the credential.

customerId
required
string (CustomerId) <= 50 characters

Customer resource ID.

id
string <= 50 characters

ID of the credential.

expiredTime
string <date-time>

Date and time when the credential expires.

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "customer"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/credentials
Request samples 
$customerCredentials = $client->customerCredentials()->search([
    'filter' => 'customerId:testCustomer',
]);
Response samples
application/json
[
  • {
    }
]
➔ Next to Create a credential