The application object
A comprehensive list of the application resource's attributes and relationships
The application object is returned as part of the response body of each successful retrieve API call to the /api/application
endpoint.
Fields
Field | Type | Description |
---|---|---|
type |
|
|
id |
| The application unique identifier |
links.self |
| The application endpoint URL |
attributes.name |
| The application's internal name. |
attributes.kind |
| The application's kind, can be one of: 'sales_channel', 'integration' and 'webapp'. |
attributes.public_access |
| Indicates if the application has public access. |
attributes.redirect_uri |
| The application's redirect URI. |
attributes.uid |
| The application's unique ID. |
attributes.secret |
| The application's secret. |
attributes.scopes |
| The application's scopes. |
attributes.created_at |
| Time at which the resource was created. |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.reference |
| A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever. |
attributes.reference_origin |
| Any identifier of the third party system that defines the reference code. |
attributes.metadata |
| Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format. |
meta.mode |
| The resource environment (can be one of |
Last updated