Skip to content

Jobs

Consols and shipments, including their accruals, that BravoTran fetches from the FFS.

Operations

List updated jobs

Request

Returns a list of job identifiers, optionally filtered to those updated within a time window.

Optional. Provided as an alternative to POST /events for partners that cannot push live event notifications. Implement either the events API or the list endpoints — not both.

A job's updated_at reflects changes to nested data as well (accruals, child shipments linked, etc.), so this endpoint surfaces any change that should trigger a re-sync. Response items contain only external_id. To fetch full job details, call GET /jobs/{external_id} for each entry.

Security
OAuth2.0-Partner or Bearer-Token-Partner
Query
updated_afterstring, (date-time)

Inclusive lower bound on updated_at. ISO 8601 UTC datetime (e.g., 2025-02-17T20:32:39Z). Date-only values are not accepted. Optional.

updated_beforestring, (date-time)

Exclusive upper bound on updated_at. ISO 8601 UTC datetime (e.g., 2025-02-18T20:32:39Z). Date-only values are not accepted. Optional, but if provided, updated_after is required.

curl -i -X GET \
  'https://apidocs.bravotran.com/_mock/openapi/jobs?updated_after=2025-02-17T20%3A32%3A39Z&updated_before=2025-02-18T20%3A32%3A39Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of job identifiers updated in the given window.

Bodyapplication/json
Array [
external_idstringrequired

The external_id of the referenced entity.

]
Response
[
  {
    "external_id": "db3b1f33-2335-4fc5-a874-f8284a95d539"
  },
  {
    "external_id": "5f13f433-5228-4ce0-bb23-765285682111"
  }
]