Skip to main content

Get a list of resources​

Retrieve a paged collection of resources (required scope resources:read)

Query Parameters
    sortBy ResourceSortOptions

    Possible values: [name, createdAt]

    The field to sort items in the page by

    direction SortDirection

    Possible values: [ascending, descending]

    The direction to apply the sort

    name string

    Only return resources where name matches or starts with the value provided

    reference string[]

    Only return resources where reference matches the value(s) provided

    id int64[]

    Only return resources where id matches the value(s) provided

    groupId int64[]

    Only return resources where groupId matches the value(s) provided

    pageNumber int32

    Possible values: >= 1 and <= 2147483

    The page number being requested (minimum: 1, maximum: 2147483)

    pageSize int32

    Possible values: >= 1 and <= 1000

    The page size being requested (minimum: 1, maximum: 1000)

Header Parameters
    Customer-Id int64 required

    The customer identifier

Responses

Success

Schema
    items object[]

    The items returned for the requested page

  • Array [
    • id int64

    The unique identifier of the resource

    createdAt date-time

    The UTC timestamp of when this resource was created

    reference string

    The internal reference of the resource - should usually be unique

    name string

    The full name of the resource

    groupId int64

    The unique identifier of the resource's group

    groupName string

    The name of the resource's group

    mobile string nullable

    The mobile telephone number of the resource

    timeZoneId string

    The id of the timezone that the resource operates in

    maxTravelDistance int32 nullable

    The maximum number of kilometres the resource will travel from start location (as crow flies)

    fuelCard string nullable

    The fuel card number associated to the resource

    businessKey string nullable

    The number associated to the resources business key

    privateKey string nullable

    The number associated to the resources private key

    tachoCard string nullable

    The tachograph driver card number associated to the resource

    isTracked boolean

    Indicates whether tracking data should be collected for this resource

    isTrackedOutOfHours boolean

    Indicates whether out of working hour tracking data is private

    workingHours object[]

    The resources working hours / shifts, expressed relative to timeZoneId

  • Array [
    • dayOfWeek DayOfWeek

    Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]

    Possible values:

    • sunday
    • monday
    • tuesday
    • wednesday
    • thursday
    • friday
    • saturday
    start time

    The UTC 24H format time of day that the resource starts their shift (hh:mm)

    stop time

    The UTC 24H format time of day that the resource stops their shift (hh:mm)

    startAtContactId int64 nullable

    The unique identifier of the contact (location) that the resource starts this shift from

    startAtLocation object

    Represents a geographical location

    latitude double required

    Latitude of the center of the location

    longitude double required

    Longitude of the center of the location

  • ]
    • customFields object[]

    Custom fields associated with the resource

  • Array [
    • definitionId int64

    The unique identifier of the associated custom field definition

    value string nullable

    The current value set for the custom field

    definition object

    Represents the definition of a custom field

    caption string

    The caption of a custom field

    type CustomFieldType

    Possible values: [boolean, integer, decimal, text, list, statement, date, note, time, systemList]

    The type of the custom field. New field types may be added in the future, so integrations should be resilient to this

    Possible values:

    • boolean: Indicates a boolean field (Example: "false")
    • integer: Indicates an integer numeric field (Example: "1001")
    • decimal: Indicates a floating point numeric field (Example: "1.42")
    • text: Indicates an editable text field (Example: "Purple")
    • list: Indicates a field with a single value from a predefined list of options (Example: "Purple")
    • statement: Indicates a text field that cannot be edited. The value is always equal to the default value (Example: "By signing this you agree to the following...")
    • date: Indicates a date field, which will be represented as an RFC3339 formatted date string. The default value is not supported for this type and will always be null (Example: "2024-01-31")
    • note: Indicates a multiline, editable text field. Lines are seperated with a line feed character (Example: "This is a note.")
    • time: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null (Example: "10:30")
    • systemList: Indicates the ID of a related resource, vehicle or web user (Example: "228007")

    listOptions string[] nullable

    Shows the possible values for a list type custom field. Value will be null if type is not list

    isRequired boolean

    Indicates if the field is required in the UI. This is NOT enforced in the API

    isEditable boolean

    Indicates if the field is editable

    default string nullable

    The default value of a custom field. Formatted in accordance with the rules of the field type

    systemListValueMetadata object

    Represents details of custom field value of type system list

    label string nullable

    A descriptive label for the specific resource, vehicle or web user that this system list value relates to

    entityType CustomFieldSystemListType

    Possible values: [resource, vehicle, webUser]

    The type of entity used for custom field value of type system list

    Possible values:

    • resource
    • vehicle
    • webUser

  • ]
  • ]
    • pageNumber int32

    The page number of the response where 1 is the first page

    pageSize int32

    The number of items requested for the current page

    pageItemCount int32

    The number of items returned in the current page

Loading...