API Access Token

v1_files API

/**
 * REST API end-points for interacting with the 'files' resource.
 *
 */
Sign in
Available APIs
v1_active_people v1_asignit v1_asset v1_booking v1_booking_client_contact v1_client v1_client_contact v1_depot v1_document_type v1_driver_licence_type v1_equipment v1_files v1_form v1_invoice v1_item_classification v1_lookup v1_permit v1_person v1_project v1_resource v1_sage_50 v1_skill v1_tag v1_upload v1_vehicle v1_works_docket
Methods
  • permit_file_download GET
  • permit_file GET POST
  • person_file_download GET
  • person_file GET POST PUT DELETE
  • person_image POST
  • person_skill_file_download GET
  • person_skill_file GET POST PUT DELETE
    • Help
    Definitions
    T-2.961.1
    Release Notes

    API Release Notes

    Close

    Version T-2.961.1, released on 01/07/2025

    • Third Party API: V1_person
      • Change: last_name is no longer a required field in the v1_person API. This allows for people without a last name to be created via the API.

    Version T-2.960.1, released on 30/06/2025

    • Integrations
      • Improvement: Added resource_name to the 'GET v1_works_docket/works_docket_person' end-point.
      • ⚠️ Deprecation: The redundant columns 'item_classification_id' and 'item_classification_name' will be removed from the 'GET v1_works_docket/works_docket_person' end-point on August 1, 2025.

    Version T-2.945.4, released on 14/05/2025

    • Third Party API: Permits
      • New: Added new api : v1_permit to third party API to upload permit files. Includes new access levels to upload permit files and access permit files form the third party api
        • GET permit_status
        • GET POST booking_permit
        • GET POST permit_issuer
        • GET POST permit
      • New: Added s3_upload_permit_file_post to v1_upload.php
      • New: Added permit_file_get to v1_files.php
      • New: Added permit_file_post to v1_files.php
      • New: Added permit_file_download_get to v1_files.php
      • Improvement: Removed restriction on private third parties that prevented them from being able to create, update and delete records via the API.

    Version T-2.931.3, released on 19/03/2025

    • Third party API
      • Improvement: State timezone information (state_id and state_timezone) fields have been added to `v1_booking/booking` and `v1_depot/depot` GET end-points.
      • Improvement: `v1_lookup/state` end-point has been added to look up information about about state records.

    Version T-2.911.1, released on 06/01/2025

    • Third party API
      • New Feature: Invoice Item: Invoice items have been added to the third party api within the V1_invoice api. Note: a date range is required

    Version T-2.906.1, released on 27/11/2024

    • Third party API
      • New Feature: Added PUT and POST end-points for projects. Use of these end-points is controlled with the 'Project Write Access' permission requiring a Traffio team member to enable.

    Version T-2.900.1, released on 15/10/2024

    • Third party API
      • Asset: vehicle_id added to output of asset GET
      • Asset: vehicle_id and person_id added as filters to asset GET

    Version T-2.894.1, released on 25/08/2024

    • Third party API
      • Improvement: Added end-points 'person_file_download' and 'person_skill_file_download' for downloading protected files for people and for people's skills.

    Version T-2.891.2, released on 19/09/2024

    • Third party API
      • Improvement: created_by data has been added to the output of the v1_vehicle_api vehicle end point.

    Version T-2.883.1, released on 06/08/2024

    • Third party API changes: vehicle_engine_number
      • vehicle_engine_number has been added to the output of the v1_vehicle_api vehicle end point.

    Version T-2.881.2, released on 05/08/2024

    • Get bookings by Job number is no longer a unique record
      • Job numbers can now be duplicated. This is now the case for companies that have merged their data from several pre existing Traffio Customers.
      • Get booking by job_number will now return an array of results not a single result.

    Version T-2.876.1, released on 27/07/2024

    • Third party API changes: Item_classification
      • Added a GET API endpoint 'item_classification' to show the item_classifications that are used by booking requirements.
      • Added a GET API endpoint 'item_classification_resource' to show the quantity of resources used by each item_classification.

    Version T-2.860.1, released on 06/06/2024

    • Third party API changes
      • Added a GET api endpoint 'active_people_get' to retrieve active and working people and their hours worked.

    Version T-2.851.1, released on 3/05/2024

    • Third Party API changes
      • Ordering of results has been removed from the booking_person and works_docket_person endpoints.
      • We have optimised the performance of a number of endpoints that had started to slow down.

    Version T-2.850.3, released on 2/05/2024

    • Third Party API changes
      • v1_booking: Added an endpoint for updating booking requirements
      • v1_booking: Added an endpoint for deleting booking requirements

    Version T-2.844.1, released on 15/04/2024

    • Third Party API changes
      • v1_booking: Added an endpoint for posting bookings
      • v1_booking: Added an endpoint for retrieving booking requirements
      • v1_project: Added fields required_skill_ids and required_vehicle_induction_ids when retrieving projects
      • v1_vehicle: Added an endpoint for retrieving vehicle availability
      • v1_person: Added an endpoint for retrieving a person's blocklist

    Version T-2.840.1, released on 02/04/2024

    • Third Party API: Added fields for GET Works_docket_person
      • driver_for_vehicle_id
      • passenger_for_vehicle_id
      • equipment_ids

    Version T-2.816.5, released on 06/12/2023

    • Third Party API: Added fields for GET Person
      • person_start_date
      • person_probation_date
      • person_active_date
      • person_finish_up_date
      • driver_licence_type_name
      • person_driver_licence_number
      • person_driver_licence_date_granted
      • person_driver_licence_expiry_date

    Version T-2.811.3, released on 31/10/2023

    • Third Party API: Depot
      • 'customer_name' has been added to the output of GET depot

    Version T-2.799.1, released on 01/08/2023

    • Third party API changes
      • Added third party API end-point for availability (person leave). The end point can be found in the v1_person api.
      • v1_person:person endpoint person_lng, person_lat
      • v1_booking:booking has new fields added: booking_lng, booking_lat, booking_touches_shifts
      • booking_touches_shifts can be used to match available periods for weekday day/night shifts using a bitwise comparison. The mapping can be found in the person availability api

    Version T-2.793.1, released on 15/08/2023

    • Third Party API
      • An API for Assets has been added under V1_asset.

    Version T-2.792.1, released on 11/08/2023

    • Third Party API
      • Booking write access has been added to the third party V1_booking API
      • Currently limited to writing booking person records. Will be expanded to cover equipment, and vehicles shortly.
      • booking_person_put, booking_person_delete added
      • is_non_billable added to the booking person api
      • booking_write_access added to the third party interface. this must be selected for the third party token to be able to write to bookings

    Version T-2.717.1, released on 23/11/2022

    • Third party API end-points
      • Added third party API end-points for retrieving booking vehicles, booking equipment, forms and form submissions. Requires corresponding third party permissions to be switched on - see 'Integrations' > Select a 'Personal' third party.

    Version T-2.693.2, released on 14/9/2022

    • Third party works dockets API
      • Added third party API end-points for retrieving works docket records. Requires the third party permission 'Works Docket Read Access' to be switched on - see 'Integrations' > Select a 'Personal' third party > 'Works docket read access' field.

    Version T-2.692.2, released on 12/9/2022

    • Third party person API: update person
      • A person can now be updated through the third party API using eth PUT method if the token has write permission
      • Not all fields can be updated
      • This will allow Staffd to update existing users with their new release next week

    Version T-2.689.2, released on 5/9/2022

    • Third party person API: Second Emergency Contact
      • A second emergency contact has been added.
      • Added to input of POST person: person_emergency_contact_name2, person_emergency_contact_phone2, person_emergency_contact_relationship2
      • Added to output of GET person: person_emergency_contact_name, person_emergency_contact_phone, person_emergency_contact_relationship, person_emergency_contact_name2, person_emergency_contact_phone2, person_emergency_contact_relationship2

    Version T-2.655.1, released on 6/5/2022

    • Third party booking API
      • Added to output of get booking: client_order_number
      • Added to output of get booking: client_billing_code

    Version T-2.645.4, released on 21/4/2022

    • Staffd integration : bugfix
      • Newly uploaded employees from Staffd would always default to a "candidate" if an avatar image was also uploaded. Uploaded employees will now have the status that is specified
      • Social inclusions, Gender, and Pronouns are now included in Traffio's third party API. It is expected that Staffd will soon include these fields in uploads to Traffio

    Version T-2.542.1, released on 24/08/2021

    • Issuing new access tokens for third parties will now revoke previous access tokens.
    • Made links which are issued to third parties for generating access tokens, expire after 30 days un-viewed and 24 hours once viewed.

    Version T-2.535.1, released on 17/08/2021

    • Traffio support tools
      • This is for the Traffio Support Team
      • Conversations now have dynamic links to the customer, the contact and their conversations
      • Report links have been added, as well as a new teleportation tool
      • fixed bug with creating new methods, and methods now have coloured tags

    Version T-2.534.1, released on 16/08/2021

    • Internal 3rd party integrations
      • You can setup access to your Traffio data using the API by creating your own 'Third Party' integration. See the 'Integrations' main menu (moved from 'My Company').
      • Your integrations are restricted to reading your data while Traffio approved integrations will have limited ability to read and write to your data depending on their requirements.
      • You have full control of which integrations can access your data.

    Version T-2.490.1, released on 14/05/2021

    • Added ability to upload a person's profile image, documents and skill-documents via the third party API.

    Version T-2.360.1, released on 11/05/2020

    • Third Party API
      • Third party API end points have been added for vehicles and equipment
      • API has also been opened up to allow third parties to update ODO readings and schedules of service
      • Vehicle issues may also be reported and maintained through the third party api

    Version T-2.330.1, released on 6/2/2020

    • Third Party API
      • Released today is the Traffio third party API for external software to hook into. You can allow external software vendors to make use of this API by generating a token for them through My Company > Integrations.
      • The first third party software available through the platform is Actiond. Link: https://Actiond.io
      • Actiond provides surveys which gauge client and employee satisfaction
    Returns a URL for a single requested 'permit_file' from which the file asset can be downloaded. The URL remains valid for 20 minutes.
    Passing the 'should_redirect' parameter with a value of '1' will redirect the requester to the asset with a 302 HTTP status.
    This end-point requires the 'permit_read_access' and 'file_read_access' permissions.
    UNKNOWN
    Field Description
    Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
    eg: "name,description,created_by"

    Currently only enabled for GET requests using formats of HTML, TSV, CSV
    Comma Separated list of columns to exclude from results.
    Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
    part of a unique ID of each permit.
    A flag to indicate if the response should redirect the requester to the asset. 0 = no, 1 = yes.
      
    Get permit files.
    @return ARRAY of permit_file
    Field Description
    Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
    eg: "name,description,created_by"

    Currently only enabled for GET requests using formats of HTML, TSV, CSV
    Comma Separated list of columns to exclude from results.
    Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
    Set to '0' to undelete the record.
    (YYYY-MM-DD HH:mm:ss), if supplied, only records modified more recent than this datetime will be returned
      
    POST permit_file
    /api_third_party/v1_files/permit_file
    Link a file with a permit. You must have access to both for this to work.
    @return Array Single record.
    Field Description
    doc type id
    Description for this file.
    The file name. (Required)
    Title for this file.
    ID of the permit to upload the file for. (Required)
      
    Returns a URL for a single requested 'person_file' from which the file asset can be downloaded. The URL remains valid for 20 minutes.
    Passing the 'should_redirect' parameter with a value of '1' will redirect the requester to the asset with a 302 HTTP status.
    This end-point requires the 'person_read_access' and 'file_read_access' permissions.
    UNKNOWN
    Field Description
    Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
    eg: "name,description,created_by"

    Currently only enabled for GET requests using formats of HTML, TSV, CSV
    Comma Separated list of columns to exclude from results.
    Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
    A flag to indicate if the response should redirect the requester to the asset. 0 = no, 1 = yes.
      
    Deletes an existing person_file record.
    This end-point requires the 'person_write_access, 'file_write_access' permissions.

    Resource response fields: Documentation to come.
    @return array Returns the file record that has been deleted.
    Field Description
    ID of the file resource to link the person to. Required.
    ID of the person to upload the file for. Required.
      
    Returns information about the 'person_skill_file' resource (referred to as 'resource' below) filterable by the fields described below.
    This end-point requires the 'person_read_access' and 'file_read_access' permissions.
    Resource response fields: Documentation to come.
    UNKNOWN
    Field Description
    Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
    eg: "name,description,created_by"

    Currently only enabled for GET requests using formats of HTML, TSV, CSV
    Comma Separated list of columns to exclude from results.
    Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
    Filter resources to match these comma separated unique IDs of the corresponding files document_type resource.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
    Filter resources to match this flag. 0 = not deleted, 1 = deleted.
    A datetime of which the resource was last modified in the format of YYYY-MM-DD HH:mm:ss. Returns records with a last_modified datetime value greater that the datetime provided.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
    Filter resources to match these comma separated unique IDs of the corresponding files tags.
      
    POST person_file
    /api_third_party/v1_files/person_file
    Creates and returns a new person_file record.
    This end-point requires the 'person_write_access' and 'file_write_access' permissions.

    Resource response fields: Documentation to come.
    @return array Returns the file record that has been created.
    Field Description
    The ID of the document_type of the file. Required.
    A description of the file. Max length: 255.
    The file name. Required. Max length: 255.
    A title for the file. Max length: 255.
    ID of the person to upload the file for. Required.
      
    Updates an existing person_file record.
    This end-point requires the 'person_write_access' and 'file_write_access' permissions.

    Resource response fields: Documentation to come.
    @return array Returns the file record that has been updated.
    Field Description
    The ID of the document_type of the file.
    A description of the file. Max length: 255.
    ID of the file resource to link the person to. Required.
    A title for the file. Max length: 255.
    Flag indicating if the resource is deleted or not. 0 = not deleted, 1 = deleted.
    ID of the person to upload the file for. Required.
      
    POST person_image
    /api_third_party/v1_files/person_image
    Creates and returns a new file record of 'person image' type.
    This end-point requires the 'person_write_access' and 'file_write_access' permissions.
    @return array Returns the file record that has been created.
    Field Description
    A description of the file. Max length: 255.
    The file name. Required. Max length: 255.
    A title for the file. Max length: 255.
    The unique ID of the person resource to which the image will be attached.
      
    Returns a URL for a single requested 'person_skill_file' from which the file asset can be downloaded. The URL remains valid for 20 minutes.
    Passing the 'should_redirect' parameter with a value of '1' will redirect the requester to the asset with a 302 HTTP status.
    This end-point requires the 'person_read_access', 'skill_read_access' and 'file_read_access' permissions.
    UNKNOWN
    Field Description
    Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
    eg: "name,description,created_by"

    Currently only enabled for GET requests using formats of HTML, TSV, CSV
    Comma Separated list of columns to exclude from results.
    Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
    A flag to indicate if the response should redirect the requester to the asset. 0 = no, 1 = yes.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Required.
      
    Deletes an existing person_skill_file record.
    This end-point requires the 'person_write_access, 'file_write_access' permissions.
    @return array Returns the file record that has been deleted.
    Field Description
    ID of the file resource. Required.
    ID of the person resource. Required.
    ID of the skill resource. Required.
      
    Returns information about the 'person_skill_file' resource (referred to as 'resource' below) filterable by the fields described below.
    This end-point requires the 'person_read_access', 'skill_read_access' and 'file_read_access' permissions.
    Resource response fields: Documentation to come.
    UNKNOWN
    Field Description
    Comma Separated list of columns to restrict results to. Order is kept. If field does not exist then column will be included, but a blank result will be returned
    eg: "name,description,created_by"

    Currently only enabled for GET requests using formats of HTML, TSV, CSV
    Comma Separated list of columns to exclude from results.
    Currently only enabled for GET requests using formats of HTML, TSV, CSV Note: Exclude field will be ignored if fields are supplied.
    Filter resources to match this unique ID of the corresponding files document_type resource.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
    Filter resources to match this flag. 0 = not deleted, 1 = deleted.
    A datetime of which the resource was last modified in the format of YYYY-MM-DD HH:mm:ss. Returns records with a last_modified datetime value greater that the datetime provided.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
    Part of the unique ID of the desired resource. Returns a single record if it exists. Other filters do not apply.
    Filter resources to match these comma separated unique IDs of the corresponding files' tags.
      
    POST person_skill_file
    /api_third_party/v1_files/person_skill_file
    Creates and returns a new person_skill_file record.
    This end-point requires the 'person_write_access' abd 'file_write_access' permissions.
    @return array Returns the file record that has been created.
    Field Description
    The ID of the document_type of the file. Required.
    A description of the file. Max length: 255.
    The file name. Required. Max length: 255.
    A title for the file. Max length: 255.
    ID of the person resource to upload the file for. Required.
    ID of the skill resource to upload the file for. Required.
      
    Updates an existing person_skill_file record.
    This end-point requires the 'person_write_access' and 'file_write_access' permissions.
    @return array Returns the file record that has been updated.
    Field Description
    The ID of the document_type of the file.
    A description of the file. Max length: 255.
    ID of the file resource. Required.
    A title for the file. Max length: 255.
    Flag indicating if the resource is deleted or not. 0 = not deleted, 1 = deleted.
    ID of the person resource. Required.
    ID of the skill resource. Required.