Retrieve Groups

get

https://example.com/groups/

Returns a list of Groups applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

template_key

string

Filter via template_key value.

group_type

string

Filter via group_type value. Defaults are "checkbox", "radiobox", "select", "text", "integer", "decimal", and "date".

case_tab

string

Filter via case tab. May be a custom string value, defaults are "demographics", "income", "identification", "identification_phone", "identification_ids", and "hmis".

section

integer

Filter via Section ID. Must supply integer value, cannot search by Section name or other field information.

allow_other

boolean

Filter via allow_other boolean value, accepts true or false. Used to determine whether or not other Agents are allowed to use this detail group.

required

boolean

Filter via required boolean value, accepts true or false. Determines whether or not a detail group is required when creating a case via the user interface.

auto_copy

boolean

Filter via auto_copy boolean value, accepts true or false. Determines whether or not a detail group value is pushed to all other members of a household.

report_summary

boolean

Filter via report_summary boolean value, accepts true or false. Determines whether or not a detail group is available in the report summary demographic totals.

searchable

boolean

Filter via searchable boolean value, accepts true or false. Determines whether or not a detail group is available in advanced searches.

display_in_relationships

boolean

Filter via display_in_relationships boolean value, accepts true or false. Determines whether or not a detail group is displayed in case relationships.

display_in_sidebar

boolean

Filter via display_in_sidebar boolean value, accepts true or false. Determines whether or not a detail group is displayed in the case sidebar.

display_in_barcode

boolean

Filter via display_in_barcode boolean value, accepts true or false. Determines whether or not a detail group is displayed in the barcode dialog.

disabled

boolean

Filter via disabled boolean value, accepts true or false. Determines whether or not a detail group is disabled and not available in the user interface.

hide_by_default

boolean

Filter via hide_by_default boolean value, accepts true or false. Determines whether or not a detail group is hidden from the user interface by default.

order_by

string

Order results by a field name. Prefix with - for descending order. eg. order_by=mod_date for ascending or order_by=-mod_date for descending. Must be a valid field on the resource; an invalid field returns a 400 error.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200search results matching criteria