# query auditing events

`GET https://api.suger.cloud/org/{orgId}/auditingEvent/query`

Query auditing events with filtering, sorting, and pagination using CRUD query language. Supports complex filters, sorting by multiple fields, and pagination.

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `orgId` | path | string | yes | Organization ID |
| `page_size` | query | integer | no | Number of items per page (default: 20, max: 1000) |
| `page_number` | query | integer | no | Page number (default: 1) |
| `q` | query | string | no | LISP-style filter expression (e.g., '(= event_type \ |
| `s` | query | string | no | Sort fields: 'field:asc,field2:desc' or '-field,field2' format (e.g., 'creation_time:desc,event_type:asc' or '-creation_time,event_type') |

## Responses

### 200 — Paginated list of auditing events

Content-Type: `application/json` · Schema: `crud.ListBaseResponse-AuditingEvent`

**`crud.ListBaseResponse-AuditingEvent`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | array<AuditingEvent> | no |  |
| `page_number` | integer | no |  |
| `page_size` | integer | no |  |
| `total_count` | integer | no |  |

**`AuditingEvent`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `aceEventBridgeEvent` | AceEventBridgeEvent | no |  |
| `alibabaMarketplaceEvent` | AlibabaMarketplaceEvent | no |  |
| `awsMarketplaceEvent` | AwsMarketplaceEvent | no |  |
| `awsMarketplaceEventBridgeEvent` | AwsMarketplaceEventBridgeEvent | no |  |
| `azureMarketplaceEvent` | AzureMarketplaceEvent | no |  |
| `creationTime` | string | no | When the event is received and audited. |
| `eventType` | string | no |  |
| `gcpMarketplaceEvent` | GcpMarketplaceEvent | no |  |
| `id` | string | no |  |
| `lastUpdateTime` | string | no | when the event is updated. |
| `organizationID` | string | no |  |
| `otherTypeEvent` | object | no | Nullable, applicable when eventType is other types. |
| `status` | string | no |  |

**`AceEventBridgeEvent`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `account` | string | no |  |
| `detail` | AceEventBridgeEventDetail | no |  |
| `detail-type` | string | no |  |
| `id` | string | no |  |
| `region` | string | no |  |
| `resources` | array<string> | no |  |
| `source` | string | no | "aws.partnercentral-selling" |
| `time` | string | no |  |
| `version` | string | no |  |

**`AlibabaMarketplaceEvent`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | AlibabaMarketplaceAction | no |  |
| `aliUid` | string | no | The Alibaba UID of the buyer's Alibaba Account. |
| `expiredOn` | string | no |  |
| `instanceId` | string | no |  |
| `isRefund` | boolean | no |  |
| `orderBizId` | string | no | Used as the Instance ID, and as the external ID for the Suger Entitlement. |
| `orderId` | string | no |  |
| `productCode` | string | no |  |
| `skuId` | string | no |  |
| `sugerOrganizationId` | string | no | Suger organization ID of this event. Populated by Suger Service. |
| `template` | string | no |  |
| `timeStamp` | string | no | When the event was received by the Suger. |
| `token` | string | no | SPI security token. |
| `trial` | boolean | no | If true, the event is for a trial. |

**`AwsMarketplaceEvent`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | string | no |  |
| `customer-identifier` | string | no |  |
| `id` | string | no |  |
| `isFreeTrialTermPresent` | string | no |  |
| `offer-identifier` | string | no |  |
| `product-code` | string | no |  |
| `sugerOrganizationId` | string | no | Populated by Suger Service. |

**`AwsMarketplaceEventBridgeEvent`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `account` | string | no | The seller/ISV AWS Account Id. |
| `detail` | AwsMarketplaceEventBridgeEventDetail | no |  |
| `detail-type` | string | no |  |
| `id` | string | no |  |
| `region` | string | no |  |
| `resources` | array<string> | no |  |
| `source` | string | no | "aws.marketplacecatalog" |
| `time` | string | no |  |
| `version` | string | no |  |

**`AzureMarketplaceEvent`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `action` | AzureMarketplaceEventAction | no |  |
| `activityId` | string | no |  |
| `id` | string | no | The Operation Id. |
| `offerId` | string | no |  |
| `operationRequestSource` | string | no |  |
| `planId` | string | no |  |
| `publisherId` | string | no |  |
| `purchaseToken` | string | no |  |
| `quantity` | integer | no |  |
| `status` | string | no |  |
| `subscription` | AzureMarketplaceSubscription | no |  |
| `subscriptionId` | string | no |  |
| `sugerOrganizationId` | string | no | Populated by Suger Service. |
| `timeStamp` | string | no |  |

**`GcpMarketplaceEvent`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `account` | GcpMarketplaceUserAccount | no |  |
| `entitlement` | GcpMarketplaceEntitlement | no |  |
| `eventId` | string | no |  |
| `eventType` | GcpMarketplacceEventType | no |  |
| `providerId` | string | no | GCP Partner ID of the SaaS Seller. |
| `publishTime` | string | no | The Publish Time of the event. |
| `sugerOrganizationId` | string | no | Populated by Suger Service. |

**`AceEventBridgeEventDetail`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `catalog` | string | no | "AWS" or "Sandbox" |
| `engagementInvitation` | AceEventEngagementInvitation | no |  |
| `opportunity` | AceEventOpportunity | no |  |
| `schemaVersion` | string | no |  |

**`AwsMarketplaceEventBridgeEventDetail`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `acceptor` | AwsMarketplaceEventBridgeEventAccount | no |  |
| `agreement` | AwsMarketplaceEventBridgeEventAgreement | no |  |
| `catalog` | string | no |  |
| `eventCategory` | string | no |  |
| `eventID` | string | no |  |
| `eventName` | string | no |  |
| `eventSource` | string | no |  |
| `eventType` | string | no |  |
| `eventVersion` | string | no |  |
| `license` | AwsMarketplaceEventBridgeEventLicense | no |  |
| `managementEvent` | boolean | no |  |
| `manufacturer` | AwsMarketplaceEventBridgeEventAccount | no |  |
| `offer` | AwsMarketplaceEventBridgeEventOffer | no |  |
| `product` | AwsMarketplaceEventBridgeEventProduct | no |  |
| `proposer` | AwsMarketplaceEventBridgeEventAccount | no |  |
| `requestID` | string | no |  |
| `requestParameters` | object | no |  |
| `resaleAuthorization` | AwsMarketplaceEventBridgeEventResaleAuthorization | no |  |
| `responseElements` | object | no |  |
| `sellerOfRecord` | AwsMarketplaceEventBridgeEventAccount | no |  |
| `targetedBuyerAccountIds` | array<string> | no |  |

**`AzureMarketplaceSubscription`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `allowedCustomerOperations` | array<string> | no |  |
| `autoRenew` | boolean | no |  |
| `beneficiary` | AzureADIdentifier | no |  |
| `created` | string | no |  |
| `fulfillmentId` | string | no |  |
| `id` | string | no |  |
| `isFreeTrial` | boolean | no |  |
| `isTest` | boolean | no |  |
| `lastModified` | string | no |  |
| `name` | string | no |  |
| `offerId` | string | no |  |
| `planId` | string | no |  |
| `publisherId` | string | no |  |
| `purchaser` | AzureADIdentifier | no |  |
| `quantity` | integer | no |  |
| `saasSubscriptionStatus` | AzureMarketplaceSubscriptionStatus | no |  |
| `sandboxType` | string | no |  |
| `sessionId` | string | no |  |
| `sessionMode` | string | no |  |
| `storeFront` | string | no |  |
| `term` | AzureTerm | no |  |

**`GcpMarketplaceUserAccount`** fields:

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `approvals` | array<GcpMarketplaceUserAccountApproval> | no | The approvals for this account, that are permitted or have been completed. |
| `billingAccountId` | string | no | The buyer's GCP billing account ID if it's a company account. |
| `createTime` | string | no | RFC3339 UTC timestamp |
| `id` | string | no | GCP Marketplace User Account ID. |
| `inputProperties` | array<integer> | no |  |
| `name` | string | no | The resource name of the account, in format of providers/{provider_id}/accounts/{account_id}. |
| `parentBillingAccountId` | string | no | The parent account ID of the BillingAccountId if the buyer is from a reseller in GCP Marketplace. It is the GCP billing account ID of the reseller in GCP Marketplace. |
| `provider` | string | no | The identifier of the service provider (SaaS Seller) that this account was created against. |
| `state` | GcpMarketplaceUserAccountState | no |  |
| `updateTime` | string | no | RFC3339 UTC timestamp |
| `userInfo` | GcpUserInfo | no |  |

### 400 — Bad request error

Content-Type: `application/json`

### 500 — Internal server error

Content-Type: `application/json`

---

Interactive API reference: https://doc.suger.io/api/