groups

Get Groups

Current groups HTTP operation. External credential scopes: read:groups. Minimum farm role: READER. Pagination accepts integer skip and take; set both explicitly. An omitted value passes through to the data query. Collection property names differ by resource; use the response schema. Production rate limit: 100 requests per 15-minute window per device account, 1000 per browser session, otherwise per client IP. RateLimit headers report the current window; respect Retry-After on 429. archived uses JavaScript boolean coercion: any nonempty query string, including false, is true. Omit this parameter for active groups.

get/v1/farm/{farm_id}/groups

Request

  • Base URL: https://api.ranch.bot
  • URL: https://api.ranch.bot/v1/farm/{farm_id}/groups
  • Auth: HTTP bearer

Path parameters

farm_idstring uuid required

Query parameters

skipinteger
takeinteger
archivedboolean

Response

Success

totalnumber required

Changes

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