SKskyfire

Get Organization Users

Changed on

As an Organization Admin, list the users in your organization.

get/api/v1/organizations/users

Request

  • Base URL
    https://api.skyfire.xyz
  • URL
    https://api.skyfire.xyz/api/v1/organizations/users
  • Auth
    API key in header skyfire-api-key

Query parameters

pageSizeinteger

Number of users to return per page. Defaults to 100, maximum 1000. e.g. 50

pageCursorstring

Cursor for the next page, taken from nextPageCursor in the previous response. Results are ordered by email ascending, and the cursor is the email of the last user on the previous page. e.g. "chloe@gmail.com"

filterstring

A JSON object, encoded as a string, restricting which users are returned. Conditions combine with AND. Must be valid JSON. Supported keys: id, email, identifier, active, admin, orgMemberRole. e.g. filter={"orgMemberRole":"REPRESENTATIVE"}

Response

Ok

nextPageCursorstring

Present when more users remain. Pass it back as pageCursor to fetch the next page.

Changes

  • 22cbec9d7630Revision changes
    • breaking

      for the query request parameter pageSize, the type changed from number to integer

    • breaking

      the // response's property type changed from string to boolean for status

    • breaking

      the // response's property type changed from string to boolean for status

    • warning

      for the query request parameter pageSize, the max was set to 1000.00

    • warning

      for the query request parameter pageSize, the min was set to 1.00

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      added the new ADMIN enum value to the // response property for the response status

    • warning

      added the new MEMBER enum value to the // response property for the response status

    • warning

      added the new REPRESENTATIVE enum value to the // response property for the response status

    • info

      for the query request parameter filter, the type was generalized from object to string

    • info

      added the non-success response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      added the required property //// to the response with the status