---
title: "Get a candidate starter from a case definition"
method: GET
path: "/cmmn-repository/case-definitions/{caseDefinitionId}/identitylinks/{family}/{identityId}"
tags: ["Case Definitions"]
---

# Get a candidate starter from a case definition

`GET /cmmn-repository/case-definitions/{caseDefinitionId}/identitylinks/{family}/{identityId}`

## Request

- Base URL: `https://developer-docs.flowable.com/cmmn-api`
- URL: `https://developer-docs.flowable.com/cmmn-api/cmmn-repository/case-definitions/{caseDefinitionId}/identitylinks/{family}/{identityId}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/docs/cmmn-repository/case-definitions/:caseDefinitionId/identitylinks/:family/:identityId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `caseDefinitionId` string, required
- `family` string, required
- `identityId` string, required

## Response `200`

Indicates the case definition was found and the identity link was returned.

- RestIdentityLink
  - `url` string
  - `user` string
  - `group` string
  - `type` string

## Other responses

- `404`: Indicates the requested case definition was not found or the case definition does not have an identity-link that matches the url.

---

[API](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api.md) - [All operations](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/flowable/apis/flowable-cmmn-rest-api/revisions/afdfa1fcacd0?raw)