Nodes

List Workspace Nodes

Retrieve a list of all available Workspace Nodes.

get/api/v1/workspaces/{workspaceID}/nodes

Request

  • Base URL: https://app.coalescesoftware.io
  • URL: https://app.coalescesoftware.io/api/v1/workspaces/{workspaceID}/nodes
  • Auth: HTTP bearer

Query parameters

detailboolean

Include the full detail of the nodes.

skipParsingboolean

Set to true to skip parsing Node transforms for a faster response. Use skipParsing=true on its own or together with detail=true. Both combinations are supported. With detail=true, responses include full node detail but omit parsed transform data.

limitinteger

The maximum number of items to return. Between 1 and 500.

startingFromstring

A cursor that tells the API where to begin returning results. Use it to continue pagination from a specific point in the dataset. This value must come from the next field in the previous response. If you define a query cursor using startingFrom, you must also include the orderBy parameter.

orderBystring
Example:id

The field to order the results by. Only id allowed.

Response

totalinteger

Number of records returned.

startingFromstring

A cursor that tells the API where to begin returning results. Use it to continue pagination from a specific point in the dataset. This value must come from the next field in the previous response. If you define a query cursor using startingFrom, you must also include the orderBy parameter.

limitinteger

Limit of the records returned. Some endpoints have limit as a query parameter. Default is 100.

nextstring nullable

The field value representing the start of the next page of results.

orderBystring

The field to order the results by. Only id allowed.

Example response

{
  "data": [
    {
      "nodeType": "externalDataPackage:::372"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.