Query parameters

• userId array[string(uuid)]

  Filter the results by user ID.

  Multiple identifiers can be specified by repeating the query parameter. e.g. userId=id1&userId=id2

  This parameter supports a maximum of 30 identifiers.

  At least 1 but not more than 30 elements.

• externalId array[string]

  Filter the results by external ID.

  Multiple identifiers can be specified by repeating the query parameter. e.g. externalId=id1&externalId=id2

  This parameter supports a maximum of 30 identifiers.

  At least 1 but not more than 30 elements.

• upn array[string]

  Filter the results by user UPN.

  Multiple identifiers can be specified by repeating the query parameter. e.g. upn=id1&upn=id2

  This parameter supports a maximum of 30 identifiers.

  At least 1 but not more than 30 elements.

• username array[string]

  Filter the results by username.

  Multiple identifiers can be specified by repeating the query parameter. e.g. username=id1&username=id2

  This parameter supports a maximum of 30 identifiers.

  At least 1 but not more than 30 elements.

• name string

  Filter the results by the user's name.

• email string(email)

  Filter the results by email address.

• role string

  Filter the results by user role.

  Values are manager, editor, leadership, guardian, teacher, or student.

• limit integer(int32)

  Specify the pagination limit, defaults to 100

  Minimum value is 1, maximum value is 100. Default value is 100.

• offset integer(int32)

  Specify the pagination offset, defaults to 0.

  Cannot be used with cursor

  Default value is 0.

• cursor string(byte) | null

  Provide the next or previous page cursor

• sort object

  Specify the sort order of the results.

  The default sort order is sort[field]=createdAt&sort[direction]=desc

  Hide sort attributes Show sort attributes object

  • field string

    The available sort fields.

    Values are createdAt, updatedAt, firstName, or lastName.

  • direction string

    The sort direction used for ordering the results. Can be "asc" (ascending) or "desc" (descending).

    Values are asc or desc.

Responses

• 200 application/json

  List of users.

  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • userId string(uuid) Required

      User UUID

    • roles array[string]

      User roles

      Values are manager, editor, leadership, guardian, teacher, or student.

    • username string Required

      The username of the user.

    • upn string

      The Unique Pupil Number (UPN) of the user.

    • externalId string

      External user identifier provided during onboarding or signup

    • fullName string Required

      The full name of the user.

    • firstName string Required

      The first name of the user.

    • middleName string

      The middle name of the user.

    • lastName string Required

      The last name of the user.

    • emails array[string(email)]

      A list of all email addresses associated with the user.

    • gender string Required

      The gender of the user.

      Values are male, female, other, or unknown. Default value is unknown.

    • dateOfBirth string(date)

      The date of birth of the user.

    • createdAt string(date-time)

      ISO 8601 formatted datetime string

    • updatedAt string(date-time)

      ISO 8601 formatted datetime string

  • pagination object Required
    Hide pagination attributes Show pagination attributes object

    • total integer(int32) Required

      The total number of items available.

    • limit integer(int32) Required

      The maximum number of results to return per page.

      Minimum value is 1, maximum value is 100. Default value is 100.

    • offset integer(int32) Required

      Indicates the starting position or index (offset)

      Default value is 0.

    • previousCursor string(byte) | null Required

      The cursor for pagination. Encoded byte string used to navigate between pages.

    • nextCursor string(byte) | null Required

      The cursor for pagination. Encoded byte string used to navigate between pages.

• 400

  Invalid request.

• 401

  Invalid authentication credentials

• 403

  Not authorised to access this resource