Bringg

Bringg Drivers API

The Drivers API from Bringg — 15 operation(s) for drivers.

GitHub OpenAPI

Operations 15

POST /services/assign_task Assign Order To Driver #
POST /services/assign_run_driver Assign Driver To Route #
POST /services/unassign_run_driver Unassign Driver From Route #
POST /services/create_blacklisted_customer_user Create Blacklisted Customer Driver #
DELETE /services/delete_blacklisted_customer_user Delete Blacklisted Customer Driver #
GET /services/get_blacklisted_customer_users Get Blacklisted Customer Drivers #
POST /services/logoff_user Logoff Driver #
POST /services/generate_driver_qr_code Generate Driver QR Code #
POST /services/generate_pickup_qr_code Generate Pickup QR Code #
POST /services/driver_home_events Initiate Driver Home Events #
GET /services/get_realtime_availability Get Driver Availability #
POST /services/update_driver_location Update Driver Location #
POST /partner/driver-is-assigned-to-order Assign Driver #
POST /partner/update-driver-location Update Driver Location #
GET /partner/driver-location Driver Location #

Documentation

📖
Documentation
https://developers.bringg.com/reference/welcome-to-bringgs-api-reference
📖
Documentation
https://developers.bringg.com/docs/overview
📖
Documentation
https://developers.bringg.com/docs/rest
📖
Authentication
https://developers.bringg.com/docs/bringg-api-access-management
📖
Authentication
https://developers.bringg.com/docs/oauth-20-urls
📖
Documentation
https://developers.bringg.com/reference/driver-shifts
📖
Documentation
https://developers.bringg.com/reference/users-3
📖
Documentation
https://developers.bringg.com/reference/vehicles
📖
Documentation
https://developers.bringg.com/reference/delivery-blocks
📖
Documentation
https://developers.bringg.com/reference/overview-1
📖
GettingStarted
https://developers.bringg.com/reference/how-to-get-started
📖
Documentation
https://developers.bringg.com/reference/getting-certified
📖
Documentation
https://developers.bringg.com/reference/how-to-conduct-and-end-to-end-test
📖
Documentation
https://developers.bringg.com/reference/webhooks
📖
Documentation
https://developers.bringg.com/reference/webhooks-index

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/openapi/bringg-drivers-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/asyncapi/bringg-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/json-schema/bringg-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/json-schema/bringg-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/json-schema/bringg-waypoint-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/json-schema/bringg-run-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/json-structure/bringg-order-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/json-schema/bringg-driver-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/json-ld/bringg-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/examples/bringg-create-task-example.json
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/bringg/refs/heads/main/graphql/bringg-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bringg-drivers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bringg-drivers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bringg Drivers API
  version: '1.0'
  contact:
    name: Bringg Developer Support
    url: https://developers.bringg.com
  license:
    name: Bringg API Terms of Service
    url: https://developers.bringg.com/reference/terms-of-service
  description: 'Operations tagged Drivers across 3 of this provider''s published API definitions: bringg-delivery-hub-api-openapi.yml, bringg-drivers-shifts-api-openapi.yml, bringg-fleet-partners-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://us2-admin-api.bringg.com
  description: US2 region (GCP)
- url: https://us3-admin-api.bringg.com
  description: US3 region (GCP)
- url: https://us4-admin-api.bringg.com
  description: US4 region (GCP)
- url: https://eu2-admin-api.bringg.com
  description: EU2 region (GCP)
- url: https://eu3-admin-api.bringg.com
  description: EU3 region (GCP)
- url: https://app.bringg.com
  description: Bringg security gateway
- url: https://partner.example.com
  description: Partner-hosted endpoints (replace with your base URL for callbacks)
security:
- OAuth2ClientCredentials: []
tags:
- name: Drivers
paths:
  /services/assign_task:
    post:
      summary: Assign Order To Driver
      description: Assign an order directly to a specific driver.
      tags:
      - Drivers
      operationId: assignTask
      responses:
        '200':
          description: Assigned.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/assign_run_driver:
    post:
      summary: Assign Driver To Route
      description: Assign a driver to a route (run) to fulfill its orders.
      tags:
      - Drivers
      operationId: assignRunDriver
      responses:
        '200':
          description: Driver assigned to run.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/unassign_run_driver:
    post:
      summary: Unassign Driver From Route
      description: Remove a driver from a route assignment.
      tags:
      - Drivers
      operationId: unassignRunDriver
      responses:
        '200':
          description: Driver unassigned.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/create_blacklisted_customer_user:
    post:
      summary: Create Blacklisted Customer Driver
      description: Block a driver from delivering to a specific customer.
      tags:
      - Drivers
      operationId: createBlacklistedCustomerUser
      responses:
        '200':
          description: Blacklist entry created.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/delete_blacklisted_customer_user:
    delete:
      summary: Delete Blacklisted Customer Driver
      description: Remove a blacklist entry between customer and driver.
      tags:
      - Drivers
      operationId: deleteBlacklistedCustomerUser
      responses:
        '200':
          description: Blacklist removed.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/get_blacklisted_customer_users:
    get:
      summary: Get Blacklisted Customer Drivers
      description: List blacklist entries between drivers and customers.
      tags:
      - Drivers
      operationId: getBlacklistedCustomerUsers
      responses:
        '200':
          description: Blacklist list.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/logoff_user:
    post:
      summary: Logoff Driver
      description: Log a driver out of the Bringg Driver App.
      tags:
      - Drivers
      operationId: logoffUser
      responses:
        '200':
          description: Logged off.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/generate_driver_qr_code:
    post:
      summary: Generate Driver QR Code
      description: Generate an access token and QR code for Driver App login of a specified driver.
      tags:
      - Drivers
      operationId: generateDriverQrCode
      responses:
        '200':
          description: QR code generated.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/generate_pickup_qr_code:
    post:
      summary: Generate Pickup QR Code
      description: Generate a pickup QR code for an order or location.
      tags:
      - Drivers
      operationId: generatePickupQrCode
      responses:
        '200':
          description: QR code generated.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/driver_home_events:
    post:
      summary: Initiate Driver Home Events
      description: Indicate whether a driver is at or has departed their home base.
      tags:
      - Drivers
      operationId: driverHomeEvents
      responses:
        '200':
          description: Event recorded.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/get_realtime_availability:
    get:
      summary: Get Driver Availability
      description: Retrieve real-time driver availability across specified teams.
      tags:
      - Drivers
      operationId: getRealtimeAvailability
      responses:
        '200':
          description: Availability returned.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /services/update_driver_location:
    post:
      summary: Update Driver Location
      description: Push a driver's GPS location for more accurate ETA calculations.
      tags:
      - Drivers
      operationId: updateDriverLocation
      responses:
        '200':
          description: Location updated.
    servers:
    - url: https://us2-admin-api.bringg.com
      description: US2 region (GCP)
    - url: https://us3-admin-api.bringg.com
      description: US3 region (GCP)
    - url: https://us4-admin-api.bringg.com
      description: US4 region (GCP)
    - url: https://eu2-admin-api.bringg.com
      description: EU2 region (GCP)
    - url: https://eu3-admin-api.bringg.com
      description: EU3 region (GCP)
  /partner/driver-is-assigned-to-order:
    post:
      summary: Assign Driver
      description: Notify Bringg a partner driver has been assigned to an order.
      tags:
      - Drivers
      operationId: driverIsAssignedToOrder
      responses:
        '200':
          description: Assigned.
    servers:
    - url: https://app.bringg.com
      description: Bringg security gateway
    - url: https://partner.example.com
      description: Partner-hosted endpoints (replace with your base URL for callbacks)
  /partner/update-driver-location:
    post:
      summary: Update Driver Location
      description: Partner pushes driver GPS coordinates to Bringg.
      tags:
      - Drivers
      operationId: partnerUpdateDriverLocation
      responses:
        '200':
          description: Location updated.
    servers:
    - url: https://app.bringg.com
      description: Bringg security gateway
    - url: https://partner.example.com
      description: Partner-hosted endpoints (replace with your base URL for callbacks)
  /partner/driver-location:
    get:
      summary: Driver Location
      description: Retrieve current driver location.
      tags:
      - Drivers
      operationId: getDriverLocation
      responses:
        '200':
          description: Location returned.
    servers:
    - url: https://app.bringg.com
      description: Bringg security gateway
    - url: https://partner.example.com
      description: Partner-hosted endpoints (replace with your base URL for callbacks)
components:
  securitySchemes:
    OAuth2ClientCredentials:
      type: oauth2
      description: 'OAuth 2.0 Client Credentials Grant. Exchange your client_id and client_secret

        for an access token via POST https://admin-api.bringg.com/oauth/token (or the

        regional equivalent), then send Authorization: Bearer <access_token>.

        '
      flows:
        clientCredentials:
          tokenUrl: https://admin-api.bringg.com/oauth/token
          scopes:
            create_task: Create orders
            update_task: Update orders
            get_task: Read orders
            cancel_task: Cancel orders
            assign_task: Assign orders to drivers
            checkin: Driver check-in
            checkout: Driver check-out
            create_customer: Create customers
            update_customer: Update customers
            create_team: Create teams
            create_service_area: Create service areas
            create_service_plan: Create service plans
            get_quotes: Get delivery quotes
x-refined-from:
- bringg-delivery-hub-api-openapi.yml
- bringg-drivers-shifts-api-openapi.yml
- bringg-fleet-partners-api-openapi.yml