/
Retrieve applications

Retrieve applications

Request

Retrieves a list of applications that are available in the Rebilly App Store. Applications may be sorted by: id, name, status, createdTime, and updatedTime.

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

Limits the number of collection items to be returned.

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.

expandstring

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 Embedded resources.

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/applications?limit=1000&offset=1000&filter=string&q=string&expand=string&fields=string&sort=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of applications retrieved.

Headers
Pagination-Totalinteger

Total number of items.

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

Unique identifier of the application.

Example:"app_01H0HT25X7XXCJGS4H8VJSYF2Y"
namestringrequired

Name that is displayed for the application in the App Store.

logoIdstring, <= 50 charactersrequired

Unique identifier of the file that contains the application logo.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
authorNamestringrequired

Name of the person or organization that created the application.

authorLogoIdstring or null, <= 50 characters

Unique identifier of the file that contains the logo of the author.

Example:"4f6cf35x-2c4y-483z-a0a9-158621f77a21"
taglinestringrequired

Short descriptive tagline that is displayed for the application in the App Store.

descriptionstringrequired

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

statusstringread-only

Current status of the application in the App Store.

Enum:"pending-approval""available""disabled"
permissionsArray of strings, (operationId)required

List of permissions that are available to the application. To add permissions, contact Rebilly Support.

Items Enum:"DeleteApplicationInstance""GetApplicationInstanceConfiguration""GetCustomer""GetCustomerCollection""GetInvoice""GetInvoiceCollection""GetPlan""GetPlanCollection""GetProduct""GetProductCollection"
Example:
[
  "GetInvoice",
  "GetInvoiceCollection",
  "GetCustomer",
  "GetCustomerCollection"
]
configurationUrlstring or null, (uri)

URL for configuring the application during installation.

configuredBystringread-only

Specifies who can configure the application.

Enum:"user""application"
propertiesobject

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

Example:
{
  "type": "object",
  "properties": {
    "email": { … },
    "max": { … }
  },
  "required": [
    "email"
  ]
}
createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

_embeddedobjectread-only

Embedded objects that are requested by the expand query parameter.

]
Response
[
  {
    "id": "app_01H0HT25X7XXCJGS4H8VJSYF2Y",
    "name": "string",
    "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "authorName": "string",
    "authorLogoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
    "tagline": "string",
    "description": "string",
    "status": "pending-approval",
    "permissions": [ … ],
    "configurationUrl": "http://example.com",
    "configuredBy": "user",
    "properties": { … },
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ],
    "_embedded": { … }
  }
]