/
Retrieve an application i...

Retrieve an application instance

Request

Retrieves an application instance with specified application and organization IDs.

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

ID of the resource.

organizationIdstring, <= 50 characters^[@~\-\.\w]+$required

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

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

Responses

Application instance 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
statusstringread-only

Current status of the application instance.

Enum:"enabling""enabled""disabling""disabled"
isConfiguredbooleanread-only

Specifies if the configuration of the application instance is complete. Some applications require additional configuration after installation before they can be used. Configuration is completed using the Upsert an application instance configuration operation.

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.

organizationIdstring, <= 50 characters(OrganizationId)read-only

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Example:"org_0YVDM8RC7GDADADSBSMW124JA8"
tokenstringread-only

Session token used to authenticate an organization.

settingsobjectread-onlydeprecated

Configuration settings submitted during installation.

Example:
{
  "color": "red",
  "limit": "5"
}
Response
{
  "status": "enabling",
  "isConfigured": true,
  "settings": {
    "color": "red",
    "limit": "5"
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ],
  "organizationId": "org_0YVDM8RC7GDADADSBSMW124JA8",
  "token": "string"
}