Skip to content
RipsClouddevelopers

List rips packages

GET/api/v1/workspaces/{workspaceId}/rips-packages

Operation ID: ripsPackages.list · Access: PAT with read scope and authorized workspace where applicable · Effect: read.

Read the rips packages workflow before this operation.

Parameters

Section titled “Parameters”
Name In Required Type / allowed values
workspaceId path Yes string
kind query No RipsPackageKind
status query No RipsPackageStatus
sourceInvoiceId query No string
sourceCreditNoteId query No string
sourceDebitNoteId query No string
q query No string
includeArchived query No true, false
limit query No integer
offset query No integer or null

Responses

Section titled “Responses”
HTTP Content Schema
200 application/json RipsPackageList
400 application/json ApiError
401 application/json ApiError
403 application/json ApiError
404 application/json ApiError
500 application/json ApiError

Use error.code, error.issues, and requestId for JSON errors. Error and recovery guide.

cURL

Section titled “cURL”

Set the connection variables from the quickstart. Set each path variable to an authorized identifier or an allowed parameter value from the table above.

Terminal window
curl --fail-with-body --request GET \
  "$RIPSCLOUD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/rips-packages" \
  --header "Authorization: Bearer $RIPSCLOUD_TOKEN" \
  --header 'Accept: application/json'