---
title: "Get a resource"
method: GET
path: "/v1/resources/{resourceId}"
tags: ["Resources"]
---

# Get a resource

`GET /v1/resources/{resourceId}`

Retrieve the details of a single resource (required scope resources:read)

## Path parameters

- `resourceId` integer, required

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- ReadResourceModel — Represents a model for reading a resource
  - `id` integer — The unique identifier of the resource
  - `createdAt` string, 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` integer — 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` integer, 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` ReadWorkingHourModel[] — The resources working hours / shifts, expressed relative to `timeZoneId`
    - `dayOfWeek` 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' — <p>Possible values:</p><ul><li><b>sunday</b></li><li><b>monday</b></li><li><b>tuesday</b></li><li><b>wednesday</b></li><li><b>thursday</b></li><li><b>friday</b></li><li><b>saturday</b></li></ul>
    - `start` string, time — The UTC 24H format time of day that the resource starts their shift (hh:mm)
    - `stop` string, time — The UTC 24H format time of day that the resource stops their shift (hh:mm)
    - `startAtContactId` integer, nullable — The unique identifier of the contact (location) that the resource starts this shift from
    - `startAtLocation` Location — Represents a geographical location
      - `latitude` number, double, required — Latitude of the center of the location
      - `longitude` number, double, required — Longitude of the center of the location
  - `customFields` CustomFieldReadModel[] — Custom fields associated with the resource
    - `definitionId` integer — The unique identifier of the associated custom field definition
    - `value` string, nullable — The current value set for the custom field
    - `definition` CustomFieldEmbeddedDefinitionModel — Represents the definition of a custom field
      - `caption` string — The caption of a custom field
      - `type` '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<p>Possible values:</p><ul><li><b>boolean</b>: Indicates a boolean field <i>(Example: "false")</i></li><li><b>integer</b>: Indicates an integer numeric field <i>(Example: "1001")</i></li><li><b>decimal</b>: Indicates a floating point numeric field <i>(Example: "1.42")</i></li><li><b>text</b>: Indicates an editable text field <i>(Example: "Purple")</i></li><li><b>list</b>: Indicates a field with a single value from a predefined list of options <i>(Example: "Purple")</i></li><li><b>statement</b>: Indicates a text field that cannot be edited. The value is always equal to the default value <i>(Example: "By signing this you agree to the following...")</i></li><li><b>date</b>: 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 <i>(Example: "2024-01-31")</i></li><li><b>note</b>: Indicates a multiline, editable text field. Lines are seperated with a line feed character <i>(Example: "This is a note.")</i></li><li><b>time</b>: Indicates a time field, formatted as HH:mm. The default value is not supported for this type and will always be null <i>(Example: "10:30")</i></li><li><b>systemList</b>: Indicates the ID of a related resource, vehicle or web user <i>(Example: "228007")</i></li></ul>
      - `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` SystemListValueMetadataModel — 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` 'resource' | 'vehicle' | 'webUser' — The type of entity used for custom field value of type system list<p>Possible values:</p><ul><li><b>resource</b></li><li><b>vehicle</b></li><li><b>webUser</b></li></ul>

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)