Skip to main content

Gets assignee via a single related task

GET/jsonapi/tasks/{id}/assignee

Where id is the identifier of the task

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

id path required

idinteger

format: int32

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request GET "${API_BASE_URL}/jsonapi/tasks/{id}/assignee" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "UserId: $ADVISER_CONTACT_ID" \
--header 'Accept: application/vnd.api+json'

Responses

200 response

application/vnd.api+json

Example response body

Generated from the OpenAPI Specification with illustrative values. Shows primary data and attributes where defined; optional links, relationships and included resources are omitted. Actual values and returned fields depend on your request and access.

{
"data": {
"type": "advisers",
"id": "1001",
"attributes": {
"googlePlaces": "string",
"created": "2026-01-15T09:00:00Z",
"isBrokerWebPublic": false,
"myLeadGenActivationDate": "2026-01-15T09:00:00Z",
"isMyLeadGenActive": false,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "alex@example.com",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "https://example.com/",
"profilePhotoHalfBody": "https://example.com/",
"profilePhotoFullBody": "https://example.com/",
"countryCode": "NZ",
"youtubeChannel": "string"
}
}
}
200 responseobjectAdviserDocument ↗
metaobjectread only
jsonApiobjectread only
linksall ofread only
dataobjectrequiredAdviser ↗
includedarray · nullableread only

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.