/
Retrieve application

Retrieve application

Request

Retrieves an application from the Rebilly App Store with the specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/applications/{id}' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Application 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
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": [
    "GetInvoice",
    "GetInvoiceCollection",
    "GetCustomer",
    "GetCustomerCollection"
  ],
  "configurationUrl": "http://example.com",
  "configuredBy": "user",
  "properties": {
    "type": "object",
    "properties": { … },
    "required": [ … ]
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ],
  "_embedded": {
    "applicationInstance": { … }
  }
}