Rhumbix

Rhumbix Batch Export API

Export Data from Rhumbix

Documentation GitHub OpenAPI

Operations 3

GET /{company_key}/batch/workshift/export/{batch_key}/status Workshift Batch Status #

GET /{company_key}/batch/workshift/export/{batch_key}/results Workshift Batch Results #

POST /{company_key}/batch/workshift/export Workshift Export Request #

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/rhumbix:rhumbix-batch-export-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  version: 1.0.1
  description: The Rhumbix API is intended for use by Rhumbix customers and partners to build integrations with the Rhumbix application.
  x-logo:
    url: https://s3.amazonaws.com/rmbx-export-assets/rmbx_horizontal_logo_colored.png
  title: Rhumbix Public Batch Export API
servers:
- url: https://async-api.rhumbix.com
tags:
- name: Batch Export
  description: Export Data from Rhumbix
paths:
  /{company_key}/batch/workshift/export/{batch_key}/status:
    get:
      responses:
        '200':
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
          description: batch is PENDING (in-process) or COMPLETE
          content:
            application/json:
              schema:
                title: BatchWorkshiftExportStatusResponse
                required:
                - status
                type: object
                example:
                  status: PENDING
                properties:
                  status:
                    $ref: '#/components/schemas/BatchStatus'
            application/xml:
              schema:
                title: BatchWorkshiftExportStatusResponse
                required:
                - status
                type: object
                example:
                  status: PENDING
                properties:
                  status:
                    $ref: '#/components/schemas/BatchStatus'
        '202':
          description: url does not exist yet but will when batch queues up
          content:
            application/json:
              schema:
                title: BatchWorkshiftExportStatusAcceptedResponse
                required:
                - status
                type: object
                example:
                  status: ACCEPTED
                properties:
                  status:
                    $ref: '#/components/schemas/BatchStatus'
            application/xml:
              schema:
                title: BatchWorkshiftExportStatusAcceptedResponse
                required:
                - status
                type: object
                example:
                  status: ACCEPTED
                properties:
                  status:
                    $ref: '#/components/schemas/BatchStatus'
      parameters:
      - required: true
        name: company_key
        in: path
        schema:
          type: string
      - required: true
        name: batch_key
        in: path
        schema:
          type: string
      tags:
      - Batch Export
      summary: Workshift Batch Status
      security:
      - RMBXApiAuthorizer: []
      - api_key: []
      operationId: batchWorkshiftExportStatus
      x-code-samples:
      - lang: Shell
        source: 'curl -X GET -H "Content-Type: application/json" \

          -H "x-api-key: foobarbazbuz" \

          https://async-api.rhumbix.com/V1_0_1/greatco/batch/workshift/export/1234abcd-56ef-gh78-ijkl-mnopqrstuvwx90/status

          # {"status": "PENDING"}

          sleep 60

          curl -X GET -H "Content-Type: application/json" \

          -H "x-api-key: foobarbazbuz" \

          https://async-api.rhumbix.com/V1_0_1/greatco/batch/workshift/export/1234abcd-56ef-gh78-ijkl-mnopqrstuvwx90/status

          # {"status": "COMPLETE"}'
      - lang: Python
        source: "import requests, time\nheaders = {\n    'x-api-key': 'foobarbazbuz', \n    'Accept': 'application/json', \n    'Content-Type': 'application/json'\n}\n\ncompany_key = 'greatco'\nbatch_key = '1234abcd-56ef-gh78-ijkl-mnopqrstuvwx90'\nurl = 'https://async-api.rhumbix.com/V1_0_1/{0}'\\\n      '/batch/workshift/export/{1}/status'.format(\n          company_key, batch_key)\nresult = requests.get(url, headers=headers)\nprint result.json() \n# {'status': 'PENDING'}\ntime.sleep(60)\nresult = requests.get(url, headers=headers)\nprint result.json() \n# {'status': 'COMPLETE'}"
      description: Retrieve the processing status of a workshift export batch using the batch_key value that was returned when the batch was created. After creating a new export batch, you should poll this endpoint to monitor the status as your batch is processed asynchronously. When the returned status is "Complete", retrieve your exported data by calling the export results method.
  /{company_key}/batch/workshift/export/{batch_key}/results:
    get:
      responses:
        '200':
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
          description: batch complete
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Workshift'
                type: array
                example:
                  errors:
                    bad_query_term:
                    - This is not an acceptable filter parameter.
                  workshifts:
                  - work_shift_key: D7bKqP5r
                    foreman:
                      first_name: John
                      last_name: Johnson
                      company_supplied_id: JON02
                      classification: ''
                      is_active: true
                      user_role: FOREMAN
                      trade: ''
                      phone: '9876543211'
                      email: johnj@company.com
                    start_time: '2017-01-03T22:38:33.885000Z'
                    timezone: America/Los_Angeles
                    timecard_entries:
                    - employee:
                        first_name: John
                        last_name: Johnson
                        company_supplied_id: JON02
                        classification: ''
                        is_active: true
                        user_role: FOREMAN
                        trade: ''
                        phone: '9876543211'
                        email: johnj@company.com
                      work_components:
                      - cost_code:
                          code: HF-669
                          group: HF
                          description: Electrical Gear
                          project_job_number: '73617665666572726973'
                          erp_units: ''
                          units: ''
                        is_approved: true
                        over_time_minutes: 0
                        double_time_minutes: 0
                        standard_time_minutes: 240
                      - cost_code:
                          code: HF-770
                          group: HF
                          description: Platform Conduit
                          project_job_number: '73617665666572726973'
                          erp_units: ''
                          units: meters
                        is_approved: true
                        over_time_minutes: 60
                        double_time_minutes: 0
                        standard_time_minutes: 240
                      forms: []
                    - employee:
                        first_name: Tom
                        last_name: Tomson
                        company_supplied_id: TOM01
                        classification: apprentice
                        is_active: true
                        user_role: WORKER
                        trade: carpenter
                        phone: '9876543210'
                        email: tomt@company.com
                      work_components:
                      - cost_code:
                          code: HF-770
                          group: HF
                          description: Platform Conduit
                          project_job_number: '73617665666572726973'
                          erp_units: ''
                          units: meters
                        is_approved: true
                        over_time_minutes: 0
                        double_time_minutes: 0
                        standard_time_minutes: 480
                      forms: []
                    end_time: '2017-01-04T01:11:58.160000Z'
                  - work_shift_key: v5PAbn3L
                    foreman:
                      first_name: John
                      last_name: Johnson
                      company_supplied_id: JON02
                      classification: ''
                      is_active: true
                      user_role: FOREMAN
                      trade: ''
                      phone: '9876543211'
                      email: johnj@company.com
                    start_time: '2017-01-04T19:42:28.283000Z'
                    timezone: America/Los_Angeles
                    timecard_entries:
                    - employee:
                        first_name: John
                        last_name: Johnson
                        company_supplied_id: JON02
                        classification: ''
                        is_active: true
                        user_role: FOREMAN
                        trade: ''
                        phone: '9876543211'
                        email: johnj@company.com
                      work_components:
                      - cost_code:
                          code: HF-669
                          group: HF
                          description: Electrical Gear
                          project_job_number: '73617665666572726973'
                          erp_units: ''
                          units: ''
                        is_approved: true
                        over_time_minutes: 0
                        double_time_minutes: 0
                        standard_time_minutes: 240
                      forms: []
                    end_time: '2017-01-05T23:07:18.124000Z'
                title: BatchWorkshiftExportResultsResponse
      parameters:
      - required: true
        name: company_key
        in: path
        schema:
          type: string
      - required: true
        name: batch_key
        in: path
        schema:
          type: string
      tags:
      - Batch Export
      summary: Workshift Batch Results
      security:
      - RMBXApiAuthorizer: []
      - api_key: []
      operationId: batchWorkshiftExportResults
      x-code-samples:
      - lang: Shell
        source: 'curl -X GET -H "Content-Type: application/json" \

          -H "x-api-key: foobarbazbuz" \

          https://async-api.rhumbix.com/V1_0_1/greatco/batch/workshift/export/1234abcd-56ef-gh78-ijkl-mnopqrstuvwx90/results

          # {"errors": {"bad_query_term": ["This is not an acceptable filter parameter."]}, "workshifts": [{"work_shift_key": "D7bKqP5r", "foreman": { "<foreman details>" }, "start_time": "2017-01-03T22:38:33.885000Z", "timecard_entries": [ "<timecard entry details>" ], "end_time": "2017-01-04T01:11:58.160000Z"}]}'
      - lang: Python
        source: "import requests, time\nheaders = {\n    'x-api-key': 'foobarbazbuz', \n    'Accept': 'application/json', \n    'Content-Type': 'application/json'\n}\n\ncompany_key = 'greatco'\nbatch_key = '1234abcd-56ef-gh78-ijkl-mnopqrstuvwx90'\nurl = 'https://async-api.rhumbix.com/V1_0_1/{0}'\\\n      '/batch/workshift/export/{1}/results'.format(\n          company_key, batch_key)\nresult = requests.get(url, headers=headers)\nprint result.json() \n# {\n  'errors': {\n    'bad_query_term': [\n      'This is not an acceptable filter parameter.'\n    ]\n  },\n  'workshifts': [\n    {\n      'end_time': '2017-01-04T01:11:58.160000Z',\n      'foreman': { '<foreman details>' },\n      'start_time': '2017-01-03T22:38:33.885000Z',\n      'timecard_entries': ['<timecard entry details>'],\n      'work_shift_key': 'D7bKqP5r'\n    }\n  ]\n}"
      description: Retrieve the results of a completed workshift export batch. You should poll the export status for this batch until it returns a status of "COMPLETE" before trying to retrieve these results.
  /{company_key}/batch/workshift/export:
    post:
      description: Post a new request to export workshift data asynchronously from Rhumbix. Returns the new batch_key for subsequently retrieving status and results for this batch.
      parameters:
      - description: The unique company key associated with your api key.
        required: true
        name: company_key
        in: path
        schema:
          type: string
      tags:
      - Batch Export
      summary: Workshift Export Request
      security:
      - RMBXApiAuthorizer: []
      - api_key: []
      operationId: batchWorkshiftExport
      x-code-samples:
      - lang: Shell
        source: "curl -X POST -H \"Content-Type: application/json\" \\\n-H \"x-api-key: foobarbazbuz\" \\\n-d '{\"start_time\": \"2014-01-01\", \"end_time\": \"2014-01-07\", \n\"bad_query_term\": \"a query filter parameter that will be ignored\"}' \\\nhttps://async-api.rhumbix.com/V1_0_1/greatco/batch/workshift/export\n# {'batch_key': '1234abcd-56ef-gh78-ijkl-mnopqrstuvwx90'}"
      - lang: Python
        source: "import requests\ndata = {\n    'start_time': '2014-01-01', \n    'bad_query_term': 'this will be ignored', \n    'end_time': '2014-01-07'\n}\n\nheaders = {\n    'x-api-key': 'foobarbazbuz', \n    'Accept': 'application/json', \n    'Content-Type': 'application/json'\n}\n\ncompany_key = 'greatco'\nurl = 'https://async-api.rhumbix.com/V1_0_1/{}'\\\n      '/batch/workshift/export'.format(company_key)\nresult = requests.post(url, headers=headers, json=data)\nprint result.json() \n# {'batch_key': '1234abcd-56ef-gh78-ijkl-mnopqrstuvwx90'}"
      responses:
        '200':
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
          description: batch request received
          content:
            application/json:
              schema:
                title: BatchWorkshiftExportResponse
                type: object
                example:
                  batch_key: 1234abcd-56ef-gh78-ijkl-mnopqrstuvwx90
                properties:
                  batch_key:
                    $ref: '#/components/schemas/BatchKey'
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/WorkshiftQuery'
              type: array
              example:
                start_time: '2014-01-01'
                bad_query_term: a query filter parameter that will be ignored
                end_time: '2014-01-07'
              title: BatchWorkshiftExportRequest
        description: An array of of queries describing data you would like to export from Rhumbix.
        required: true
components:
  schemas:
    WorkComponents:
      type: object
      properties:
        cost_code:
          $ref: '#/components/schemas/CostCode'
        double_time_minutes:
          type: integer
        standard_time_minutes:
          type: integer
        over_time_minutes:
          type: integer
      title: WorkComponents
    Employee:
      required:
      - company_supplied_id
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        company_supplied_id:
          type: string
          description: Unique id for each employee
        classification:
          type: string
        is_active:
          type: boolean
        user_role:
          enum:
          - ADMIN
          - FOREMAN
          - PM
          - WORKER
          - OFFICE_STAFF
          type: string
        trade:
          type: string
        phone:
          type: string
        project_job_numbers:
          items:
            type: string
          type: array
        email:
          type: string
      title: Employee
    TimecardEntry:
      type: object
      properties:
        employee:
          $ref: '#/components/schemas/Employee'
        work_components:
          items:
            $ref: '#/components/schemas/WorkComponents'
          type: array
      title: TimecardEntry
    CostCode:
      type: object
      properties:
        units:
          type: string
        code:
          type: string
        description:
          type: string
        project_job_number:
          type: string
      title: CostCode
    Workshift:
      type: object
      properties:
        workshift_key:
          type: string
        foreman:
          $ref: '#/components/schemas/Employee'
        timecard_entries:
          items:
            $ref: '#/components/schemas/TimecardEntry'
          type: array
      title: Workshift
    BatchStatus:
      enum:
      - NOT_FOUND
      - ACCEPTED
      - PROCESSING
      - COMPLETE
      - ERROR
      type: string
      title: BatchStatus
    BatchKey:
      type: string
      title: BatchKey
    WorkshiftQuery:
      required:
      - start_time
      - end_time
      type: object
      properties:
        start_time:
          type: string
          format: dateTime
        end_time:
          type: string
          format: dateTime
      title: WorkshiftQuery
  securitySchemes:
    api_key:
      in: header
      type: apiKey
      example: abcdefghijklmnopqrstuvwxyz0123456789
      name: x-api-key
    RMBXApiAuthorizer:
      example: abcdefghijklmnopqrstuvwxyz0123456789
      type: apiKey
      name: x-api-key
      in: header
x-servers:
- url: //async-api.rhumbix.com/V1_0_1
  description: Server URL