Docs
Get Rate Card
GET /rate-cards/{rateCardId}
GET
/rate-cards/{rateCardId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Returns one rate card with its minimums, rates and reset definitions, plus the type that owns it.
Requires
EventBasicAccess permission on the event.Event scoping: This endpoint does not include
{eventId} in the URL. The event is determined automatically from your x-Event-Token.Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| rateCardId | Guid | Required | The rate card. |
Response Fields
| Field | Type | Description |
|---|---|---|
| id | Guid | The card. |
| name | string | Name. |
| costMinimumAmount / chargeMinimumAmount | decimal| null | Money floor per span. |
| costMinimumUnits / chargeMinimumUnits | decimal| null | Time floor, in `minimumUnitsPeriod`. |
| minimumUnitsPeriod | string | `Hour`, `Day`, `Week` or `Month`. |
| periodResetDefinitionId / minimumAmountResetDefinitionId / minimumUnitsResetDefinitionId | Guid| null | The clocks the card's periods and minimums reset on. |
| orgCorrelationId | Guid| null | Set when the card came from the org library. |
| rateCount | int | Number of rates. |
| rates | array | `{ id, resourceStateId, stateName, stateColor, stateIcon, period, costFixed, costVariable, chargeFixed, chargeVariable, coversHours, costMinimumBillableUnits, chargeMinimumBillableUnits, resetDefinitionId }`. |
| resetDefinitions | array | `{ id, name, resetType, blockTypeId, blockTypeName, minDuration, durationUnit, period, periodStartDay }`. |
| owner | object | `{ resourceTypeId, name, trackingType }`. A composite owner's cards are charge-only. |
Error Codes
| HTTP Status | Description |
|---|---|
| 404 | Rate card not found on this event. |