groups
List groups
get/groups
Request
- Base URLhttps://api.lumahealth.io/api/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
namestring
Descriptive label of a group. This is the only way to link a group in Luma with another in an external service, as the group doesn't have an "externalId" field.
facilitiesstring[]
The IDs of the facilities associated with this group.
type'user' | 'system'
Indicates if a group was created by users or by the system.
createdBystring
The ID of the user who created this object.
updatedBystring
The ID of the user who updated this object.
createdAtstring date-time
The date/time when this object was created.
updatedAtstring date-time
The date/time when this object was updated.
pageinteger
limitinteger
How many items to fetch per page
_populatestring
Response properties which will be replaced by the referenced objects, separated by commas.
_selectstring
Response properties that should be returned, separated by commas.
Response
List of groups
Changes
No recorded changes to this operation across all 6 revisions of this API.