Show Task entity.

GETRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.tasks.get({
  id: 0,
});

Responses

200404

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "originalDueDate": "originalDueDate",
  "dueDate": "dueDate",
  "taskAttachments": [
    {
      "id": 0,
      "name": "name",
      "filename": "filename",
      "url": "url",
      "type": "type"
    }
  ],
  "taskCategories": [
    {
      "id": 0,
      "description": "description",
      "created": "created",
      "modified": "modified",
      "staffMemberOrganization": {
        "id": 0,
        "name": "name",
        "address": "address",
        "postalCode": "postalCode",
        "locality": "locality",
        "country": "country",
        "email": "email",
        "phoneNumber": "phoneNumber",
        "vatNumber": "vatNumber",
        "companyRegistrationNumber": "companyRegistrationNumber",
        "iban": "iban",
        "bic": "bic",
        "created": "created",
        "modified": "modified"
      }
    }
  ],
  "taskChangeNotes": [
    {
      "id": 0,
      "createdBy": "createdBy",
      "note": "note",
      "created": "created"
    }
  ],
  "taskChecklist": [
    {
      "id": 0,
      "description": "description",
      "created": "created",
      "modified": "modified"
    }
  ],
  "staffMemberSpecifications": [
    {
      "id": 0,
      "name": "name",
      "email": "email",
      "created": "created",
      "phoneNumber": "phoneNumber",
      "phoneNumberHome": "phoneNumberHome",
      "phoneNumberWork": "phoneNumberWork",
      "profilePicture": "profilePicture",
      "token": "token",
      "contactId": "contactId",
      "confirmedPushNotification": false,
      "allowedToChangeTasks": false,
      "modified": "modified",
      "taskCategory": {
        "id": 0,
        "description": "description",
        "created": "created",
        "modified": "modified",
        "staffMemberOrganization": {}
      },
      "staffMemberOrganization": {
        "id": 0,
        "name": "name",
        "address": "address",
        "postalCode": "postalCode",
        "locality": "locality",
        "country": "country",
        "email": "email",
        "phoneNumber": "phoneNumber",
        "vatNumber": "vatNumber",
        "companyRegistrationNumber": "companyRegistrationNumber",
        "iban": "iban",
        "bic": "bic",
        "created": "created",
        "modified": "modified"
      }
    }
  ],
  "created": "created",
  "title": "title",
  "description": "description",
  "done": false,
  "automatic": false,
  "dueTime": "00:00:00",
  "start": "start",
  "end": "end",
  "priority": 200,
  "status": "open",
  "amount": 0,
  "numOfPersons": 0,
  "numOfDays": 0,
  "numOfPets": 0,
  "hasNextReservation": false,
  "stale": false,
  "hasCustomDueDate": false,
  "hasCustomDueTime": false,
  "createdBy": "createdBy",
  "completedBy": "completedBy",
  "startedBy": "startedBy",
  "accommodationUnit": {
    "id": 0,
    "number": "number",
    "locale": "locale",
    "content": {
      "id": 0,
      "locale": "locale",
      "organization": {
        "id": 1000
      },
      "description": "description"
    },
    "features": [
      {
        "id": 1000
      }
    ],
    "reference": "reference",
    "latitude": "latitude",
    "longitude": "longitude",
    "public": true,
    "active": true,
    "availabilityEnabled": false,
    "available": true,
    "petsAllowed": true,
    "area": 0,
    "created": "created",
    "modified": "modified"
  },
  "automaticTask": {
    "id": 0,
    "priority": 0,
    "taskCategories": [
      {
        "id": 0,
        "description": "description",
        "created": "created",
        "modified": "modified",
        "staffMemberOrganization": {}
      }
    ],
    "accommodations": [
      {
        "id": 0,
        "title": "title",
        "slug": "slug",
        "position": 0,
        "planningPosition": 0,
        "dashboardPosition": 0,
        "locale": "locale",
        "availablePriceIncludingSupplementOrderLinesTotal": true,
        "displayNewLabel": true,
        "eligibleNumOfDaysSpecifications": [
          {}
        ],
        "eligibleNumOfPersonsSpecifications": [
          {}
        ],
        "content": {
          "id": 0,
          "title": "Zandsteeg 58",
          "metaTitle": "Zandsteeg 58",
          "locale": "locale",
          "organization": {},
          "subtitle": "Mooi vakantiehuis in Zoetewater",
          "excerpt": "Een geheel gerenoveerd vakantiehuis net buiten het dorp, maar nog altijd maar op 400m van het strand.",
          "description": "description",
          "iframeUrl": "https://www.youtube.com/embed/aqz-KE-bpKQ?modestbranding=1&controls=0",
          "energyLabelEnabled": true,
          "energyLabel": "A++++",
          "customFacilities": []
        },
        "mediaItemAlbums": [
          {}
        ],
        "reference": "reference",
        "image": "image",
        "address": "address",
        "postalCode": "postalCode"
      }
    ]
  }
}

Response 404

Not found

application/json

Example 1

{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}

Path parameters

• idnumberrequired

Returns

Schema shown for 200 · application/json

Loading response fields…