/
List credential root item...

List credential root items

Request

Retrieves a list of root items for a specified credential.

Security
SecretApiKey or JWT
Path
typestringrequired

Type of service credential.

Enum:"smtp""webhook""mailgun""sendgrid""aws-ses""oauth2""postmark""experian""taxjar""avalara"
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

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.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

qstring

Use this field to perform a partial search of text fields.

fieldsstring

Limits the returned fields to the specified list, each field separated by a comma. The ID value is always returned.

sortArray of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/service-credentials/{type}/{id}/items?limit=0&offset=0&filter=string&q=string&fields=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of credential root items 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 [
idstringread-only

ID of the Google Spreadsheet.

Example:"2ytkMntAC2Ke7aIgpaOBjz9IORRlNRjwFqO7KvyNam3B"
namestringread-only

Name of the Google Spreadsheet.

Example:"Spreadsheet 1"
]
Response
[
  {
    "id": "2ytkMntAC2Ke7aIgpaOBjz9IORRlNRjwFqO7KvyNam3B",
    "name": "Spreadsheet 1"
  }
]