Retrieve a study task spec

GET

https://acme-api.invivo.benchling.com/api/public/v1/studies/:studyId/task-specs/:taskSpecId

GET

/api/public/v1/studies/:studyId/task-specs/:taskSpecId

curl https://acme-api.invivo.benchling.com/api/public/v1/studies/sdy_3vQ8kZpLmN2xRt7YwBcDfG/task-specs/tsp_2Z3wOcuU0l0s9H6up0umd6 \
     -H "Authorization: Bearer <token>"

{
  "id": "tsp_2Z3wOcuU0l0s9H6up0umd6",
  "title": "string",
  "description": "string",
  "type": "measurement",
  "execution": {
    "measurement_workflow": {
      "assign_identifier": "donor",
      "cursor_position": "string",
      "measurements": [
        "weight",
        "body_temperature"
      ],
      "weight_percentage_change": "first_measurement"
    },
    "type": "string"
  },
  "schedule": {
    "time": {
      "type": "all_day",
      "timed": {
        "from": "09:00:00",
        "to": "09:00:00"
      }
    },
    "timezone": "America/Los_Angeles",
    "type": "one_off",
    "one_off": {
      "duration": {
        "start": "2026-09-18",
        "end": "2026-09-18"
      }
    },
    "recurring": {
      "duration": {
        "start": "2026-09-18",
        "end": "2026-09-18"
      },
      "repeat": {
        "value": 1,
        "unit": "days",
        "on_day": [
          "monday"
        ]
      }
    },
    "conditional": {
      "condition": {
        "type": "age",
        "value": [
          1
        ],
        "unit": "days"
      }
    }
  },
  "target": {
    "type": "animal"
  },
  "study": {
    "id": "sdy_3vQ8kZpLmN2xRt7YwBcDfG",
    "project_id": "pjt_9kLmNpQrStUvWxYzAbCdEf",
    "name": "string",
    "code": "string",
    "study_code_id": "sdc_7hJ4nQrXsT9wYzAbCdEfGh",
    "type": "internal",
    "status": "in_progress",
    "description": "string",
    "timezone": "America/Los_Angeles",
    "metadata": {
      "cohort_size": 24,
      "species": "Mus musculus"
    },
    "author": {
      "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
      "name": "string",
      "email": "string",
      "timezone": "string"
    },
    "owner": {
      "id": "usr_2fBnKqWxYz5tRvMpLsJdHc",
      "name": "string",
      "email": "string",
      "timezone": "string"
    },
    "started_on": "2026-09-18",
    "tracking_day_base": 1,
    "completed_at": "2026-09-18T14:03:22.123456Z",
    "canceled_at": "2026-09-18T14:03:22.123456Z",
    "created_at": "2026-09-18T14:03:22.123456Z",
    "updated_at": "2026-09-18T14:03:22.123456Z"
  },
  "created_at": "2026-09-18T14:03:22.123456Z",
  "updated_at": "2026-09-18T14:03:22.123456Z"
}

Retrieves the details of an existing task specification.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

studyIdstringRequiredformat: "^sdy_[a-zA-Z0-9]{10,22}$"

The unique identifier of the study.

taskSpecIdstringRequiredformat: "^tsp_[a-zA-Z0-9]{10,22}$"

The unique identifier of the task specification.

Response headers

X-RateLimit-LimitintegerOptional

The number of requests permitted in the current rate limit window.

X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional

The number of seconds until the current rate limit window resets.

Response

The requested task specification.

idstringformat: "^tsp_[a-zA-Z0-9]{10,22}$"

Unique identifier for a study task specification.

titlestring

The title of the task specification.

descriptionstring or null

The description of the task specification.

typeenum

The kind of work a task specification describes.

Allowed values:

executionobject or null

Execution configuration for typed task specs. Null for other task specs.

scheduleobject

Schedule for a task specification. The type discriminator selects which of one_off, recurring or conditional is present; the others are omitted. timezone is set from the study on create and always returned on read.

targetobject

Target type embedded on a task specification response.

studyobject

The study a record belongs to, as embedded in animals, dosages, measurements, observations and samples. Carries the same attributes as a study retrieved directly, except that the project is given as an identifier rather than an embedded object.

created_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

updated_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

Authentication

Path parameters

Headers

Response headers

Response

Errors