/
Retrieve credentials

Retrieve credentials

Request

Retrieves a list of authentication credentials.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

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

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/credentials?limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of authentication credentials retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
idstring, <= 50 charactersread-only

ID of the credential.

Example:"cus_crd_0YV9Y706QGCB39FQD380G1ZHZH"
usernamestringrequired

Username associated with the credential.

customerIdstring, <= 50 characters(CustomerId)required

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
expiredTimestring or null, (date-time)

Date and time when the credential expires.

]
Response
[
  {
    "id": "cus_crd_0YV9Y706QGCB39FQD380G1ZHZH",
    "username": "string",
    "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
    "expiredTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]