/
Retrieve service credenti...

Retrieve service credentials

Request

Retrieves a list of service credentials.

Security
SecretApiKey or JWT
Path
typestringrequired

Type of service credential.

Enum:"smtp""webhook""mailgun""sendgrid""aws-ses""oauth2""postmark""experian""taxjar""avalara"
Query
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.

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.

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 ,.

qstring

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

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

Responses

List of service credentials retrieved.

Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
Array [
idstring, <= 36 charactersread-only

ID of the credential.

Example:"crd_0YV9Y706QGCB39FQD380G1ZHZH"
statusstringread-only

Status of the credential.

Enum ValueDescription
active

Credential is active and can be used.

inactive

Credential is temporarily inactivated and cannot be used until reactivated.

deactivated

Credential is permanently deactivated and cannot be reactivated.

deactivationTimestring or null, (date-time)read-only

Date and time when the credential is deactivated.

typestringrequired

Type of credential.

Value:"smtp"
Discriminator
hoststringrequired

SMTP host name.

portinteger, [ 1 .. 65535 ]

SMTP port value.

Default:25
encryptionstring

Encryption value.

Default:"none"
Enum:"none""tls""ssl"
authobject(SmtpAuthorization)
hashstring, <= 36 charactersread-onlydeprecated

ID of the credential. Use the id field instead.

Example:"crd_0YV9Y706QGCB39FQD380G1ZHZH"
]
Response
[
  {
    "id": "crd_0YV9Y706QGCB39FQD380G1ZHZH",
    "hash": "crd_0YV9Y706QGCB39FQD380G1ZHZH",
    "status": "active",
    "deactivationTime": "2019-08-24T14:15:22Z",
    "type": "smtp",
    "host": "string",
    "port": 25,
    "encryption": "none",
    "auth": { … },
    "_links": [ … ]
  }
]