Sign in
Library

Get a fringe

get/library/fringes/{fringeId}

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/library/fringes/{fringeId}
  • Auth: HTTP bearer

Path parameters

fringeIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e

Response

The fringe.

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

namestring required
descriptionstring nullable required
calculationType'percent' | 'flat' | 'total' required
ratenumber nullable

Percentage for percent fringes, or the amount for flat and total fringes. For example, 7.65 means 7.65%.

cutoffnumber nullable
fringeGroupIdsId[] required
colorstring nullable required

Example response

{
  "id": "txn_8f2a1c9e",
  "fringeGroupIds": [
    "txn_8f2a1c9e"
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.