SAsalesforce
collectorGroups

Find collectorGroups

Changed on

Find a collectorGroup or collectorGroups. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

get/collectorGroups

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/collectorGroups
  • Auth
    API key in header Authorization

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

sortstring[]

Specify the sort order using a field name, e.g. '...?sort=name'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

namestring

Filter by name; asterisk (*) wildcards ok.

descriptionstring

Filter by description; asterisk (*) wildcards ok.

createdAtstring

Filter by time period when CollectorGroups were created.

updatedAtstring

Filter by time period when CollectorGroups were updated.

Response

Success, returns an array of zero or more Refocus collectorGroups.

descriptionstring

A description of the collector group.

createdBystring

Id of the user who created the collector group.

idstring

The collector group id.

namestring

The collector group name.

collectorsobject[]

List of collectors for the group.

Changes