Sign in
Library

Get a project fringe

get/projects/{projectId}/library/fringes/{fringeId}

Request

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

Path parameters

projectIdstring required

Project ID or slug.

fringeIdstring required

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

Example:txn_8f2a1c9e

Query parameters

expandLibraryExpand[]

Comma list of related data to inline on a project copy (depth ≤ 2). Unknown key returns 400 expand_invalid.

Response

The project 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
cutoffnumber nullable
fringeGroupIdsId[] required
colorstring nullable required
sourceType'workspace' | 'saturation' required

Where the project Library item came from.

sourceIdstring

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

Example response

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

Changes

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