Show StaffMember entity.

GETRequest

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

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

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

Responses

200404

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "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": {
      "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"
    }
  },
  "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"
  }
}

Response 404

Not found

application/json

Example 1

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

Path parameters

• idnumberrequired

Query parameters

• settingsbooleanoptional

Returns

Schema shown for 200 · application/json

• idnumber
• namestring
• emailstring
• phoneNumberstringoptional
• phoneNumberHomestringoptional
• phoneNumberWorkstringoptional
• profilePicturestringoptional
• tokenstringoptional
• contactIdstringoptional
• confirmedPushNotificationbooleanoptional
  Default: false
• allowedToChangeTasksbooleanoptional
  Default: false
• createdstring
• modifiedstringoptional
• taskCategoryone of 1 variantsoptional
  Show 1 variant

  • TaskCategory
    Show 5 properties

    • idnumber
    • descriptionstring
    • createdstringoptional
    • modifiedstringoptional
    • staffMemberOrganizationone of 1 variantsoptional
      Show 1 variant

      • StaffMemberOrganization
        Show 14 properties

        • idnumber
        • namestring
        • addressstringoptional
        • postalCodestringoptional
        • localitystringoptional
        • countrystringoptional
        • emailstringoptional
        • phoneNumberstringoptional
        • vatNumberstringoptional
        • companyRegistrationNumberstringoptional
        • ibanstringoptional
        • bicstringoptional
        • createdstringoptional
        • modifiedstringoptional
• staffMemberOrganizationone of 1 variantsoptional
  Show 1 variant

  • StaffMemberOrganization
    Show 14 properties

    • idnumber
    • namestring
    • addressstringoptional
    • postalCodestringoptional
    • localitystringoptional
    • countrystringoptional
    • emailstringoptional
    • phoneNumberstringoptional
    • vatNumberstringoptional
    • companyRegistrationNumberstringoptional
    • ibanstringoptional
    • bicstringoptional
    • createdstringoptional
    • modifiedstringoptional