---
title: "Get generator"
method: GET
path: "/generators/{key}"
tags: ["generators"]
---

# Get generator

`GET /generators/{key}`

Retrieve the specified generator.

## Path parameters

- `key` string, required

## Query parameters

- `fields` string[]

## Response `200`

Success, returns the specified generator.

- GeneratorResponse — The designation of which subjects and aspects to collect, plus any additional context data
  - `description` string — A description of the generator.
  - `helpEmail` string — The email address where a user can go to get more help about the generator.
  - `helpUrl` string — The url where a user can go to get more help about the generator.
  - `createdBy` string — Id of the User who created this Generator.
  - `id` string — The collector id.
  - `intervalSecs` integer — Interval (seconds) between each collection.
  - `isActive` boolean — Default false. When set to true, the generator will be assigned to a running collector and regularly send in samples.
  - `name` string — The generator's name.
  - `subjectQuery` string — The query to append to GET subjects. Only "absolutePath", "name", "tags" are allowed in subjectQuery.
  - `collectorGroup` object — Specifies set of collectors this Sample Generator should try to use.
  - `aspects` string[] — Names of the aspects.
  - `tags` string[] — Array of tag names. Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-). Tag names cannot start with a dash (-).
  - `connection` object — Information about the connection.
  - `context` object — Variables accessible inside the transform function.
  - `currentCollector` object — Current collector assigned to the generator.
  - `generatorTemplate` GeneratorTemplateResponse — The transform logic and the definition of what additional context data is required.
    - `description` string — A description of the generatorTemplate.
    - `helpEmail` string — The email address where a user can go to get more help about the generatorTemplate.
    - `helpUrl` string — The url where a user can go to get more help about the generatorTemplate.
    - `name` string — The generatorTemplate's name.
    - `version` string — The version, in semantic versioning format ( MAJOR.MINOR.PATCH )
    - `tags` string[] — Array of tag names. Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-). Tag names cannot start with a dash (-).
    - `author` object — The author of this generatorTemplate.
    - `repository` object — The repository where this generatorTemplate is located.
    - `connection` object — Information about the connection.
    - `contextDefinition` object — Variables available to connection.url, connection.toUrl, and the transform function.
    - `transform` object — The body of a javascript function which transforms some data into an array of samples
    - `isPublished` boolean — Default false. When set to true, the generatorTemplate is available to all users.
    - `id` string — The generatorTemplate id.
    - `createdBy` string — Id of the User who created this generatorTemplate.

## Other responses

- `400` — Bad Request
- `404` — Resource Not Found
- `default` — Error

## Changes

- **2018-05-17** (v1) `d16d81ef3665` — 1 info
  - added the new optional `query` request parameter `fields`
- **2018-03-30** (v1) `4ca6b20ef8df` — 1 warning
  - deleted the `query` request parameter `fields`

[Change history](https://skmtc.dev/salesforce/apis/refocus-api/changes/generators/:key/get.md)

---

[API](https://skmtc.dev/salesforce/apis/refocus-api.md) · [All operations](https://skmtc.dev/salesforce/apis/refocus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/salesforce/refocus-api/revisions/42c2153b047e/schema)