Group

Query groups

Queries groups within the given project.

get/v1/projects/{project_id}/groups

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/groups
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Query parameters

namestring

Filter groups by name

dynamicboolean

Filter groups by dynamic/non-dynamic

solution_idstring

ID of Solution

Filter groups by the solution they belong to

sort'default' | 'name'

Sort the results based on a field

sort_dir'asc' | 'desc'

Sort the results in ascending or descending order

page_sizeinteger

Number of results returned per page (max 500)

offsetinteger

Number of items to skip from beginning of result set

markerstring

'next_marker' property returned by a previous call to this API method, indicating where the next page of results should start.

countboolean

If true, the API will return the count of items matching the filter, instead of the items themselves

Response

Successful response. When count=1 parameter is provided, returns {"count": N} instead.

truncatedboolean

True if there are more results

next_markerstring

Marker for pagination

page_sizeinteger

Number of results per page

sort_dir'asc' | 'desc'

Sort direction

countinteger

Total count of matching items (only when count=1 parameter is provided)

Example response

{
  "data": [
    {
      "id": "CGb0b7201b222fa609",
      "name": "Subscribers",
      "num_members": 142,
      "time_created": 1390343845,
      "add_time_variable": "subscription_time",
      "solution_id": "SO2ad0100821a98bea",
      "url": "https://telerivet.com/p/asdf/group/CGb0b7201b222fa609",
      "project_id": "PJ2ad0100821a98bea"
    }
  ]
}

Changes

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