Availabilities

An availability is a reusable schedule of weekly periods and date overrides. For fields and response details, see the API reference.

List availabilities

This command shows availabilities in your workspace. Use this when you want to review working hours and availability schedules.

neetocal availabilities list
neetocal availabilities list --emails alice@co.com,bob@co.com

Flag	Type	Default	Description
`--emails`	`string`		Comma-separated emails to filter by
`--page`	`int`	`0`	Page number
`--page-size`	`int`	`0`	Items per page (max 100)

Sample output (--json)

{
  "data": [
    {
      "id": "01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a",
      "sid": "2nq7q5c",
      "name": "Working hours",
      "default": true,
      "periods": [
        { "id": "21c812a7-3859-4f01-b214-850e6f11caad", "wday": "monday", "start_time": "09:00 AM", "end_time": "05:00 PM" },
        { "id": "6f5a1e2b-77c4-4a0d-9c3e-1b2f3a4d5e6f", "wday": "tuesday", "start_time": "09:00 AM", "end_time": "05:00 PM" }
      ],
      "overrides": [],
      "user": { "id": "b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6", "name": "Oliver Smith", "email": "oliver@example.com" }
    }
  ],
  "pagination": { "total_records": 1, "total_pages": 1, "current_page_number": 1, "page_size": 30 }
}

Show an availability

This command shows details for one availability. Use this when you want to inspect periods and overrides after finding the availability ID from availabilities list.

neetocal availabilities show <id>

Required arguments:

<id> - Availability UUID or SID (from availabilities list)

Sample output (--json)

{
  "data": {
    "availability": {
      "id": "01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a",
      "sid": "2nq7q5c",
      "name": "Working hours",
      "default": true,
      "periods": [
        { "id": "21c812a7-3859-4f01-b214-850e6f11caad", "wday": "monday", "start_time": "09:00 AM", "end_time": "05:00 PM" },
        { "id": "6f5a1e2b-77c4-4a0d-9c3e-1b2f3a4d5e6f", "wday": "tuesday", "start_time": "09:00 AM", "end_time": "05:00 PM" }
      ],
      "overrides": [
        { "date": "2026-04-20", "periods": [] }
      ],
      "user": { "id": "b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6", "name": "Oliver Smith", "email": "oliver@example.com" }
    }
  }
}

Create an availability

This command creates a new availability. Use this when you want to set up working hours for a team member from the terminal.

neetocal availabilities create \
  --name "Working hours" \
  --email oliver@example.com \
  --time-zone "America/New_York"

Flag	Type	Required	Description
`--email`	`string`	Yes	Email address
`--json-file`	`string`		Path to JSON file with periods/overrides
`--name`	`string`		Availability name
`--time-zone`	`string`		Time zone

The optional --json-file describes the weekly periods and any date overrides:

periods.json

{
  "periods": [
    { "wday": "monday", "start_time": "09:00 AM", "end_time": "05:00 PM" },
    { "wday": "tuesday", "start_time": "09:00 AM", "end_time": "05:00 PM" }
  ],
  "overrides": [
    { "date": "2026-04-20", "periods": [] }
  ]
}

Sample output (--json)

{
  "data": {
    "availability": {
      "id": "01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a",
      "sid": "2nq7q5c",
      "name": "Working hours",
      "default": false,
      "periods": [
        { "id": "21c812a7-3859-4f01-b214-850e6f11caad", "wday": "monday", "start_time": "09:00 AM", "end_time": "05:00 PM" },
        { "id": "6f5a1e2b-77c4-4a0d-9c3e-1b2f3a4d5e6f", "wday": "tuesday", "start_time": "09:00 AM", "end_time": "05:00 PM" }
      ],
      "overrides": [],
      "user": { "id": "b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6", "name": "Oliver Smith", "email": "oliver@example.com" }
    }
  }
}

Update an availability

This command updates an availability. Use this when you need to change periods or overrides for an existing availability.

neetocal availabilities update <id> --name "Updated hours" --json-file periods.json

Required arguments:

<id> - Availability UUID or SID (from availabilities list)

Flag	Type	Required	Default	Description
`--json-file`	`string`			Path to JSON file with update data
`--name`	`string`			Availability name

Sample output (--json)

{
  "data": {
    "message": "Availability updated successfully.",
    "availability": {
      "id": "01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a",
      "sid": "2nq7q5c",
      "name": "Updated hours",
      "default": false,
      "periods": [
        { "id": "21c812a7-3859-4f01-b214-850e6f11caad", "wday": "monday", "start_time": "09:00 AM", "end_time": "05:00 PM" }
      ],
      "overrides": [],
      "user": { "id": "b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6", "name": "Oliver Smith", "email": "oliver@example.com" }
    }
  }
}

Only the fields you provide are changed.

Getting Started

Commands

List availabilities

Show an availability

Create an availability

Update an availability

​List availabilities

​Show an availability

​Create an availability

​Update an availability

List availabilities

Show an availability

Create an availability

Update an availability