Pagination

We provide the option of pagination in queries. You will find it in 2 different input formats, both of which eventually provide limit and offset parameters.

Parameters inside input object

Mostly, you will see the limit and offset inside the input object. For example:

query getJobRoles {
  getJobRoles (input: {
    offset: 0,
    limit: 100
  }) {
    count
    data {
      JobRoleId
      JobRole
    }
  }
}

Directly as Parameters

For such queries, you will find that the limit and offset parameters are the top level parameters in the input. For example:

query getAllPeople {
  getAllPeople(offset: 0, limit: 100) {
    count
    data {
      PersonID
      FirstName
      LastName
      EmailAddress
      Active
      CompanyID
      GroupId
    }
  }
}

Total Count

In the result set of all the queries, you will find 2 top level fields:

• count - provides with the total number of records for the requested data

• data - array of objects that containing the actual returned data