Users

Get Users in bulk

Changed on

Gets multiple Users

get/api/v4/users

Request

  • Base URL
    https://cabify-sandbox.com
  • URL
    https://cabify-sandbox.com/api/v4/users
  • Auth
    HTTP bearer

Query parameters

state'active' | 'pending' | 'disabled'

Filters Users by activation state. A User is pending until they follow the welcome email link and set a password; this only affects logging into Cabify's apps/web and does not prevent the User from being used as rider.id when creating journeys on their behalf.

pagenumber

Number of page to return

pernumber

Number of elements per page

Response

Success

pagenumber required

Number of page returned

pagesnumber required

Number of total available pages

pernumber required

Number of elements per page

totalnumber required

Number of total available elements

Example response

{
  "data": [],
  "page": 2,
  "pages": 0,
  "per": 1,
  "total": 0
}

Changes

    • warning

      removed the optional property // from the 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

      added the optional property // to the 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

      added the optional property // to the 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's property pattern ^[a-f0-9]{32}$ was added for the status

    • info

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

    • info

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

    • info

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