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

FieldTypeDescription

type

string

application

id

string

The application unique identifier

links.self

string

The application endpoint URL

attributes.created_at

datetime

Time at which the resource was created.

attributes.kind

string

The application's kind, can be one of: 'sales_channel', 'integration' and 'webapp'.

attributes.metadata

object

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.

attributes.name

string

The application's internal name.

attributes.public_access

boolean

Indicates if the application has public access.

attributes.redirect_uri

string

The application's redirect URI.

attributes.reference

string

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

string

Any identifier of the third party system that defines the reference code.

attributes.scopes

string

The application's scopes.

attributes.secret

string

The application's secret.

attributes.uid

string

The application's unique ID.

attributes.updated_at

datetime

Time at which the resource was last updated.

meta.mode

string

The resource environment (can be one of test or live)

Last updated