SAsalesforce
collectorGroups

Get collectorGroups

Changed on

Retrieve the specified collectorGroup metadata by the collectorGroups's id or name. You may also optionally specify a list of fields to include in the response.

get/collectorGroups/{key}

Request

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

Path parameters

keystring required

The id or name of the collectorGroup to retrieve.

Query parameters

fieldsstring[]

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

Response

Success, returns the specified collectorGroup's metadata.

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