Headers

• X-Gatego-oid

  Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • account object
    Hide account attributes Show account attributes object

    • active boolean
    • can_view_carrier_ids array[integer(int64)]
    • can_view_other_carriers boolean
    • carrier_id integer(int64)
    • deleted_at string(date-time)
    • driver object
      Hide driver attributes Show driver attributes object

      • license string
      • license_expiration string(date-time)
      • license_picture_id string
      • photo_id string
      • safety_card_picture_id string
      • truck_number string
    • driver_license string
    • driver_license_expiration string(date-time)
    • driver_license_picture_id integer(int64)
    • driver_photo_id integer(int64)
    • driver_safety_card_picture_id integer(int64)
    • driver_truck_number string
    • email string
    • email_confirmed boolean

      Whether user has confirmed his email address

    • hmac string

      HMAC-SHA256 of the user id

    • hmac_android string
    • hmac_ios string
    • id integer(int64)
    • language_code string
    • last_login string(date-time)
    • last_login_app_version string
    • last_login_referer string
    • managed_organization_group object
      Hide managed_organization_group attributes Show managed_organization_group attributes object

      • id integer(int64)
      • managed_organizations array[object]
        Hide managed_organizations attributes Show managed_organizations attributes object

        • id integer(int64)
        • name string
      • name string
    • name string
    • organization object
      Hide organization attributes Show organization attributes object

      • id integer(int64)
      • name string
    • phone_number string
    • previous_last_login string(date-time)
    • role string

      Values are ADMIN, CARRIER_ADMIN, DRIVER, GUARD, ORG_ADMIN, ORG_GROUP_ADMIN, RESTRICTED_GUARD, SIGNUP_SERVICE, SUPER_CARRIER_ADMIN, YARD_ADMIN, or YARD_DRIVER.

    • username string
    • yard_id integer(int64)
  • initial_subscriptions array[object]
    Hide initial_subscriptions attributes Show initial_subscriptions attributes object

    • active boolean
    • aggregate_usage string
    • amount integer(int64)
    • created string(date-time)
    • currency string
    • current_period_end string(date-time)
    • current_period_start string(date-time)
    • days_until_due integer(int32)
    • id string
    • price_id string
    • status string
    • tiers_mode string
    • trial_end string(date-time)
    • trial_period_days integer(int64)
    • trial_start string(date-time)
  • organization object
    Hide organization attributes Show organization attributes object

    • address string
    • address_additional_info string
    • created_at string(date-time)
    • email string
    • id integer(int64)
    • name string
    • organization_group_id integer(int64)
    • phone_number string
  • payment_method object
    Hide payment_method attributes Show payment_method attributes object

    • card object
      Hide card attributes Show card attributes object

      • brand string
      • country string
      • created integer(int64)
      • exp_month integer(int32)
      • exp_year integer(int32)
      • last4 string
    • email string
    • id string
• 201

  Created

• 401

  Unauthorized

• 403

  Forbidden

• 404

  Not Found