Groups

<button class="postman-link" onclick="event.stopPropagation();window.open('https://argoapp.postman.co/workspace/Argo~bbf8a4dc-882b-4c1a-8759-fef33ce48a64/request/18626368-bf5c7c40-9fb2-4e58-babb-d397565308f4');"><b>POSTMAN LINK</b></button>

get/api/v1/groups

Request

  • Base URL: https://api.argonav.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.argonav.io/api/v1/groups
  • Auth: none required

Query parameters

keywordstring

Filter by Keyword

exact_keywordboolean

Define type of keyword search

privacy'public' | 'private' | 'secret' | 'archived' | 'view_only'

Filter by Privacy

privacies'public' | 'private' | 'secret' | 'archived' | 'view_only'

Filter by Privacies separated by coma Ex: 'public,private'

interest_idsstring

Filter by Interest Ids separated by coma Ex: '21,23'

user_idinteger

Filter by User

role'member' | 'admin' | 'not_member'

Filter by Role

pageinteger

Actual page

page_totalinteger

Items per page

pagination_infoboolean

Add Pagination info to request

order'role_admin_first' | 'name_asc' | 'name_desc' | 'updated_at_asc' | 'updated_at_desc' | 'created_at_asc' | 'created_at_desc' | 'distance_asc' | 'distance_desc' | 'n_members_asc' | 'n_members_desc'

Order by

sw_latitudenumber

Filter by bounding box (latitude SW)

sw_longitudenumber

Filter by bounding box (longitude SW)

ne_latitudenumber

Filter by bounding box (latitude NE)

ne_longitudenumber

Filter by bounding box (longitude NE)

location'anywhere' | 'near_home_port' | 'near_me' | 'custom'

Filter by location

latnumber

Filter by latitude

lngnumber

Filter by longitude

distancenumber

Filter by distance

Include group places in response. Default is true on PUT/POST endpoints if either group_places_attributes or place_ids is set. Default is false otherwise.

Limit number of group_places in preview. Default is 10

Include group report pins in response. Default is true on PUT/POST endpoints if either group_report_pins_attributes or report_pin_ids is set. Default is false otherwise.

Limit number of group_report_pins in preview. Default is 10

Response

Respond ok

statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.