Return entitlement ledger rows matching the supplied filters.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/entitlement-operations/ledger?Operation=0&EntitlementStatus=0&SourceType=0"),};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/entitlement-operations/ledger?Operation=0&EntitlementStatus=0&SourceType=0';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/api/workspace/entitlement-operations/ledger?Operation=0&EntitlementStatus=0&SourceType=0'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Optional entitlement model filter.
Optional entitlement plan filter.
Optional entitlement id filter.
Optional human-readable entitlement number filter.
Optional owner party instance filter.
Optional resource instance filter.
Optional ledger movement type.
Optional current entitlement status filter.
Optional source type filter.
Optional renewal workflow id filter.
Optional inclusive occurrence start.
Optional inclusive occurrence end.
Optional search across entitlement number, ids, plan/model names, owner display, reason, source, and correlation.
One-based page number.
Requested page size.
Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
object
Paginated ledger response for entitlement lifecycle, renewal, and quantity history.
object
Ledger rows in the requested page.
Compact ledger row for operational lists, detail drawers, and workflow references.
object
Compact customer-owned entity instance reference.
object
Resolved user or actor display reference for entitlement ledger audit rows.
object
User identifier or stable external actor identifier stored on the ledger row.
Display name resolved from the workspace security cache when available.
User email when available.
Avatar initials.
Avatar background color.
Avatar text color.
Whether the resolved workspace user has been deleted.
Whether the stored actor identifier no longer resolves to a workspace user.
Total number of matching ledger rows before pagination.
One-based page number returned by the query.
Page size applied by the query.
object
object
object
object
Example
{ "Data": { "Items": [ { "Operation": 0, "EntitlementStatus": 0, "EntitlementEffectiveState": 0, "SourceType": 0, "Actor": { "UserType": 0 } } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}