logo

Retrieve application

Retrieves an application with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Responses
200

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

ID of the application.

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 objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "applicationInstance" "logoUrl" "authorLogoUrl"
object

Embedded objects that are requested by the expand query parameter.

object (ApplicationInstance)

Application instance object.

required
object

Settings that are available for the user to complete when they install the application. Use this object to describe fields that are rendered during installation, in the settings form.

status
string

Status of the application instance.

Enum: "enabling" "enabled" "disabling" "disabled"
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 objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/applications/{id}
Request samples 
$application = $client->applications()->load('applicationId');
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "authorName": "string",
  • "authorLogoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "tagline": "string",
  • "description": "string",
  • "status": "pending-approval",
  • "permissions": [
    ],
  • "properties": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ],
  • "_embedded": {
    }
}
➔ Next to Authentication