Sign in
Lists

List shared lists

List shared lists based on user permissions and sharing levels

get/lists

Query parameters

idstring

id

id__instring

id__in

incidentstring

incident

incident__instring

incident__in

modelstring

model

model__instring

model__in

namestring

name

name__icontainsstring

name__icontains

created_byinteger

Filter by creator user ID

created_by__instring

created_by__in

object_ids__containsstring

object_ids__contains

searchstring

search

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

sharedstring

Filter by sharing level (personal, team, organization, groups_affiliates, all, public)

Response

List of accessible lists

idinteger
created_byinteger nullable

User ID of the user who created the row.

updated_byinteger nullable

User ID of the user who last updated the row.

created_atstring date-time

Timestamp when the row was created.

updated_atstring date-time

Timestamp when the row was last updated.

parentinteger nullable

Used for branching lists. If shared_permission = read_copy and someone branches the list, this is the id of the parent list from which it was branched. This information might be useful for later comparison and syncing.

namestring required

User-generated name of a list, like Old Ladies, My Worksites, Favorite Users, Worksites in Perry FL, etc.

descriptionstring nullable

User-generated description of the list.

list_orderinteger nullable

An optional number indicating the order in which the library should be listed in any dropdown menu or other presentation. If an integer, then it floats to the top, ordered by integer. If null, then alphabetical order will win.

tagsobject nullable

jsonb list of user-generated tags to allow for easier sharing and browsing.

modelstring required

The table containing the object to which object_ids refers. Valid values include worksite_worksites, user_users, organization_organizations, incident_incidents, file_files, list_lists, organization_organizations_incidents_teams, or any other object. Some objects like wwwtsp are not suited for lists, since they are regularly invalidated and replaced. Thus, a list of wwwtsp objects would quickly become out of date.

object_idsinteger[] nullable

integer array of pseudo foreign key to the id field of the table identified in the model column.

shared'private' | 'team' | 'organization' | 'groups_affiliates' | 'all' | 'public' required

Degree to which the list is visible to or searchable by others. Valid values include private (only visible to the creating user), team (visible to all members of teams to which the creating user belongs), organization (only visible to the organization to which the creating user belongs), groups_affiliates (visible to all group or affiliated organizations), all (visible to all crisis cleanup users), public (available to the public, if that option is ever appropriate).

permissions'read_write_delete_copy' | 'read_write_copy' | 'read_copy' | 'read_only' required

The creating user always has read/write/delete access to their lists. This sets the level of management for others to which the list is shared. For example, if shared = team, and shared_permission = read_write, then all other users within the creating users team has read_write access to the list. Valid values include, read_write_delete_copy, read_write_copy, read_copy (i.e., branch or copy to another users list), and read_only. Note: individual-level permissions are not allowed, e.g., sharing to individual users, organizations, teams, etc., is not permitted. Permissions are specifically designed to be coarse, as creating individual permissions in a environment as temporary as a disaster creates more problems than it solves.

incidentinteger nullable

The incident to which the list refers. If null, then the list is not incident-specific.

invalidate_atstring date-time

Changes