Skip to main content

List of Staff

GET 
/staff

Fetches a list of Staff members.

Request​

Query Parameters

    page number

    Possible values: >= 1

    Default value: 1

    page number starts with 1

    Example: 1
    limit number

    Possible values: >= 1 and <= 100

    Default value: 10

    No of items per page

    Example: 10
    modifiedAfter date

    Start date

    Example: 2024-01-01
    modifiedBefore date

    End date

    Example: 2024-11-01

Responses​

Schema
    code stringrequired

    Status Code

    meta objectrequired

    Meta options for list responses

    page numberrequired

    Possible values: >= 1

    Default value: 1

    page number starts with 1

    limit numberrequired

    Possible values: >= 1 and <= 100

    Default value: 10

    No of items per page

    modifiedAfter date

    Start date

    modifiedBefore date

    End date

    totalRecordCount numberrequired

    No of records in the result set

    pageRecordCount numberrequired

    Possible values: <= 100

    No of records in the current page

    pageNumTotal numberrequired

    No of of pages in the result set

    include string

    Optional comma separated list of student fields included in the response

    traceContext uuid
    data object[]
  • Array [
    • communityId uuidrequired
    schoolId stringrequired
    tenantId uuidrequired
    title stringnullablerequired
    salutation stringrequired

    Staff salutation (title + preferredName||givenName + surname)

    givenName stringrequired
    preferredName stringnullablerequired
    otherGivenName stringnullablerequired
    surname stringnullablerequired
    genderId uuidnullablerequired
    gender stringnullablerequired
    genderCode stringnullablerequired
    genderSortOrder int32nullablerequired
    genderSystemMeaning stringnullablerequired

    System gender type (Male, Female, Not Stated, Other)

    birthDate datenullablerequired
    created date-timerequired
    modified date-timerequired
    schoolStaffCode stringnullablerequired
    campusId uuidnullablerequired
    roomId uuidnullablerequired
    extension stringnullablerequired

    Staff Phone Extension

    lookupStaffTypeId uuidnullablerequired
    staffDepartment object[]required

    List of departments the staff member is associated with

  • Array [
    • id uuidrequired
    description stringrequired
    code stringrequired
  • ]
    • campuses object[]required

    List of campuses the staff member is associated with

  • Array [
    • id uuidrequired
    description stringrequired
    code stringrequired
    lookup objectnullabledeprecated

    Field is deprecated and is planning to be removed, refer directly to flattened id/description/code fields instead

    id uuiddeprecated
    description stringdeprecated
    code stringdeprecated
  • ]
    • emailAddress object[]required

    List of the staff member's email addresses

  • Array [
    • id uuid

    UUID of the community member's email address record

    emailType object
    id

    UUID of the email address type lookup

    description

    The email address type (e.g. Personal, Occupation, Company, etc)

    value stringnullable

    The community member's email address

    default booleannullable

    Is this the default email address?

    sortOrder integernullable
  • ]
  • ]
Loading...