Skip to main content

This endpoint allows you to fetch a list of all groups in your Requestly account. It supports pagination for handling large datasets. For a live view and to test this API interactively, visit the API Playground.

Endpoint

  • Method: GET
  • URL: https://api2.requestly.io/v1/groups

Query Parameters

ParameterTypeDescriptionRequiredDefault Value
offsetIntegerThe index from where the results should start. Useful for pagination.No0
pageSizeIntegerThe number of results to return. Maximum value is 75.No30

cURL Request

curl --request GET \
  --url https://api2.requestly.io/v1/groups \
  --header 'accept: application/json' \
  --header 'x-api-key: your_api_key'

Sample Response

{
  "success": true,
  "data": [
    {
      "createdBy": "IUAGkRiEx6XI0B6qCc82qbwroKX2",
      "creationDate": 1736059835086,
      "currentOwnerId": "IUAGkRiEx6XI0B6qCc82qbwroKX2",
      "id": "Group_qrszh",
      "isFavourite": false,
      "lastModifiedBy": "IUAGkRiEx6XI0B6qCc82qbwroKX2",
      "modificationDate": 1736059835086,
      "name": "Group",
      "objectType": "group",
      "status": "Inactive"
    },
    ... more groups
  ],
  "nextOffset": null,
  "total": 50
}

Response Codes

Status CodeDescription
200List of groups retrieved successfully.
400Bad Request.
401Unauthorized action.
500Server error.