Skip to content
RipsClouddevelopers

Search medications — Medication catalogs

GET/api/v1/workspaces/{workspaceId}/catalogs/medications/{catalog}

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

Read the medication catalogs workflow before this operation.

Parameters

Section titled “Parameters”
Name In Required Type / allowed values
workspaceId path Yes string
catalog path Yes CUM, IUM
q query No string
limit query No integer
after query No string

Responses

Section titled “Responses”
HTTP Content Schema
200 application/json MedicationSearchResult
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/catalogs/medications/$CATALOG" \
  --header "Authorization: Bearer $RIPSCLOUD_TOKEN" \
  --header 'Accept: application/json'