Examples

This article provides examples of how to query, sort, and filter results using the Team API.

This section of the documentation provides examples that show you how to query the Team API.

Examples

Querying for users

{
  users(page: 1, per_page: 100) {
    total
    items {
      user_id
      full_name
      employee_id
      profile_picture_url
      storefront_url
      attributes {
        code
        value
      }
    }
  }
}

Querying for a specific user

{
  users(filter: { employee_id: "13524642" }, page: 1, per_page: 1) {
    total
    items {
      user_id
      full_name
      profile_picture_url
      storefront_url
    }
  }
}

Querying for custom attributes of a user

{
  users(page: 1, per_page: 100) {
    total
    items {
      user_id
      full_name
      attributes(codes: ["acknowledge_agree_collect_info"]) {
        code
        value
      }
    }
  }
}

Filtering and sorting by modified date

{
  users(
    filter: {
      modified_date: {
        gte: "2025-02-14T23:48:41.464884Z"
        lte: "2025-02-14T23:48:41.464884Z"
      } 
    } 
    sort: { name: modified_date, direction: desc }
  ) {
    items {
      user_id
      modified_date
    }
  }
}