Features supported

• Support asynchronous invocation: NO
• Supports paging: NO
• Field selection: NO
• Supplemental data: NO

curl --request GET \
  --url 'https://api.fareclock.com/orgunits?orgUnit=123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Query String

Name	Type	Required	Description
orgUnit	integer	No	Numeric ID of the organization unit

{
  "results": [
    {
      "id": 100,
      "name": "Organization Unit #1",
      "active": true,
      "payrollId": "org-unit-1",
      "timezone": "America/New_York",
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request POST \
  --url 'https://api.fareclock.com/orgunits' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Organization Unit #1",
  "active": true,
  "payrollId": "org-unit-1",
  "timezone": "America/New_York"
}'

{
  "name": "Organization Unit #1",
  "active": true,
  "payrollId": "org-unit-1",
  "timezone": "America/New_York"
}

{
  "results": [
    {
      "id": 100,
      "name": "Organization Unit #1",
      "active": true,
      "payrollId": "org-unit-1",
      "timezone": "America/New_York",
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request GET \
  --url 'https://api.fareclock.com/orgunits/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the organization unit

{
  "results": [
    {
      "id": 100,
      "name": "Organization Unit #1",
      "active": true,
      "payrollId": "org-unit-1",
      "timezone": "America/New_York",
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

curl --request PUT \
  --url 'https://api.fareclock.com/orgunits/123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Organization Unit #1",
  "active": true,
  "payrollId": "org-unit-1",
  "timezone": "America/New_York"
}'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the organization unit

{
  "name": "Organization Unit #1",
  "active": true,
  "payrollId": "org-unit-1",
  "timezone": "America/New_York"
}

{
  "results": [
    {
      "id": 100,
      "name": "Organization Unit #1",
      "active": true,
      "payrollId": "org-unit-1",
      "timezone": "America/New_York",
      "created": "2020-06-02T09:00:00.000Z",
      "modified": "2020-06-02T09:00:00.000Z"
    }
  ]
}

Retrieve active workers who have access to clock at this organization unit.

curl --request GET \
  --url 'https://api.fareclock.com/orgunits/123/allowed-employees?employee=example&limit=123' \
  --header 'Authorization: Token YOUR_API_KEY' \
  --header 'Accept: application/json'

Path

Name	Type	Required	Description
id	integer	Yes	Numeric ID of the organization unit

Query String

Name	Type	Required	Description
employee	string	No	Case-insensitive full text search of employee name
limit	integer	No	Limit the number of results (default: 25)

[
  {
    "id": 300,
    "firstName": "John",
    "middleName": null,
    "lastName": "Doe",
    "displayName": "John Doe",
    "avatar": "https://api.fareclock.com/public/avatar/300.jpg",
    "payClass": 500
  }
]