logo

List credential root items

Retrieves a list of root items for a specified credential.

SecuritySecretApiKey or JWT
Request
path Parameters
type
required
string

Type of service credential.

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

ID of the resource.

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.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

q
string

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

fields
string

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

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

Responses
200

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

ID of the Google Spreadsheet.

name
string

Name of the Google Spreadsheet.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/service-credentials/{type}/{id}/items
Request samples 
// type and id are required, other parameters are optional
const firstCollection = await api.serviceCredentials.getItems({type: 'oauth2', id: 'service-credential-1'});

// alternatively you can specify one or more of them
const params = {type: 'oauth2', id: 'service-credential-1', limit: 20, offset: 100};
const secondCollection = await api.serviceCredentials.getItems(params);
Response samples
application/json
[
  • {
    }
]
➔ Next to External identifiers