latestOpenAPI 3.0.42026-08-183012522.1 MB

66dcb6293180

Accounts6

ActivationLogs3

Activations12

Analytics13

AuditLogs4

Authentication8

AutomatedEmailEventLogs3

AutomatedEmails6

BillingAddresses3

CreditCards1

EntitlementSets9

Environments5

FeatureFlags5

Features5

Invoices2

Licenses24

LicenseTemplates5

MaintenancePolicies6

OidcConfigurations4

OrganizationActivations2

OrganizationLicenses4

OrganizationProducts2

OrganizationReleases2

Organizations5

OrganizationSamlConfigurations4

OrganizationUserGroups5

OrganizationUsers5

PersonalAccessTokens6

Plans2

Products7

ProductVersions5

Profile15

ReleaseChannels5

ReleaseDownloadEvents3

ReleaseFiles4

ReleasePlatforms5

Releases11

ResellerActivations3

ResellerLicenses8

ResellerOrganizations5

Resellers5

ResellerUsers6

SamlConfigurations5

Segments5

SendingDomains9

Tags5

TrialActivations9

TrialPolicies5

Users10

WebhookEventLogs3

Webhooks7

Products

List all products

Returns a list of products. The products are returned sorted by creation date in ascending order.

get/v3/products

Query parameters

pageinteger

The page number.

limitinteger

The number of records per page. Must be a number between 1 and 100.

sortstring

The sort string to sort the returned records e.g. "-createdAt"

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

The name of the product.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Metadata key associated with the product.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

swstring string

Matches values that start with the specified value.

ewstring string

Matches values that end with the specified value.

cnstring string

Matches values that contain the specified value.

ncstring string

Matches values that do not contain the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

Metadata value associated with the product.

customAttributeobject

Custom attribute values associated with the product, filtered as customAttribute.<name>[<op>]=value, e.g. customAttribute.region[eq]=EU.

includeIncludeProductProperties[]

Whether to include related entities in the response.

searchstring

Search string.

eqstring string

Matches values that are equal to the specified value.

nestring string

Matches values that are not equal to the specified value.

instring comma-separated-values

Matches any of the values specified.

ninstring comma-separated-values

Matches none of the values specified.

ID of the resource.

eqstring date-time

Matches values that are equal to the specified value.

nestring date-time

Matches values that are not equal to the specified value.

gtstring date-time

Matches values that are greater than the specified value.

gtestring date-time

Matches values that are greater than or equal to the specified value.

ltstring date-time

Matches values that are less than the specified value.

ltestring date-time

Matches values that are less than or equal to the specified value.

Date of creation

eqstring date-time

Matches values that are equal to the specified value.

nestring date-time

Matches values that are not equal to the specified value.

gtstring date-time

Matches values that are greater than the specified value.

gtestring date-time

Matches values that are greater than or equal to the specified value.

ltstring date-time

Matches values that are less than the specified value.

ltestring date-time

Matches values that are less than or equal to the specified value.

Date of last update

Response

idstring required

createdAtstring date-time required

updatedAtstring date-time required

namestring required

displayNamestring required

descriptionstring required

iconUrlstring nullable

publicKeystring required

totalLicensesinteger required

totalTrialActivationsinteger required

totalReleasesinteger required

totalProductVersionsinteger required

totalFeatureFlagsinteger required

automatedEmailsstring[] required

licenseTemplateIdstring required

trialPolicyIdstring required