Retrieve applications

Retrieves a list of all applications. You may sort applications by: id, name, status, createdTime, and updatedTime.

SecuritySecretApiKey or JWT
Request
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.

expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

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 applications 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
name
required
string

Name of the application.

logoId
required
string <= 50 characters

File ID of the application logo.

authorName
required
string

Name of the application author.

tagline
required
string

Tagline of the application.

description
required
string

Detailed application description. This field accepts markdown and simple text.

permissions
required
Array of strings <operationId>

List of permissions that are available to the application. If you would like to add permissions, contact Rebilly Support.

Items Enum: "PostWebhookCredentialHash" "PostWebhook" "GetWebhook" "GetCustomer" "GetCustomerCollection" "GetInvoice" "GetInvoiceCollection" "GetPlan" "GetPlanCollection" "GetProduct" … 9 more
id
string <= 50 characters

Application identifier string.

authorLogoId
string <= 50 characters

File ID of the author's logo.

status
string

Status of the application.

Enum: "pending-approval" "available" "disabled"
properties
object

Defines settings that users can complete when they install the application. This field accepts JSON-schema drafts 4, 6, and 7.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of Self (object) or ApplicationInstanceLink (object) or LogoUrlLink (object) or AuthorLogoUrlLink (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
Array of ApplicationInstanceEmbed (object) non-empty

Embedded objects that are requested by the expand query parameter.

Array (non-empty)
Any of:
object (ApplicationInstance)

Application instance object.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/applications
Request samples
$applications = $client->applications()->search([
    'filter' => 'status:available',
]);
Response samples
application/json
[
  • {
    }
]