Developer docs
/
Rebilly API
/
Customer authentication
/
Retrieve credentials

Retrieve credentials

Retrieves a list of authentication credentials.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

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

get
/credentials
Request samples
$customerCredentials = $client->customerCredentials()->search([
    'filter' => 'customerId:testCustomer',
]);
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
id
string <= 50 characters

ID of the credential.

username
required
string

Username associated with the credential.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

expiredTime
string or null <date-time>

Date and time when the credential expires.

Array of objects

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[
{
"id": "cus_crd_0YV9Y706QGCB39FQD380G1ZHZH",
"username": "string",
"customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
"expiredTime": "2019-08-24T14:15:22Z",

}
]