List Members (GET)
  • 01 Aug 2023
  • 1 Minute to read
  • Contributors

    List Members (GET)

      Article Summary

      GET /v1/users

      Get a paginated list of users.


      PropertyData TypeDescription
      pageIntegerPage to start from.
      limitIntegerThe number of records per page.
      qStringSearch string or URL encoded JSON.
      qTypeStringType of search. One of:
      • full [default]
      • partial
      qOperatorStringApplicable only if qType equals 'partial'. One of:
      • and
      • or [default]
      sortObjectMap of fields and sort order.
          "field1": "asc",
          "field2": "desc"
      Example: ?sort[field1]=asc&sort[field2]=desc

      Request Body: None

      Request Example:

      curl -X GET -H 'Authorization: Bearer <ACCESS_TOKEN>' -H 'Content-Type: application/json' '<SEARCH_WORD>&qType=full'

      Response Body:

      Status Code

      Message/Response Body




      Success. A list of users is returned.

      Response Example (200):


      Was this article helpful?