---
agentTools:
  projectIndex: https://assignr-api.readme.io/llms.txt
---

# /v2/availability/{id}

Return an availability record

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Assignr API Endpoints",
    "version": "2.0"
  },
  "security": [
    {
      "assignr_oauth2_auth_code_flow": [
        "read"
      ]
    },
    {
      "assignr_oauth2_client_credentials": [
        "read"
      ]
    }
  ],
  "tags": [
    {
      "name": "Availability",
      "description": "An official's open or unavailable dates and times"
    }
  ],
  "paths": {
    "/v2/availability/{id}": {
      "get": {
        "description": "Return an availability record",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "description": "Availability Record ID",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Return an availability record",
            "content": {
              "application/vnd.assignr.v2.hal+json": {
                "schema": {
                  "$ref": "#/components/schemas/FreeDateRepresenter"
                }
              }
            }
          }
        },
        "tags": [
          "Availability"
        ],
        "operationId": "getV2AvailabilityId"
      }
    }
  },
  "servers": [
    {
      "url": "//api.assignr.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "assignr_oauth2_client_credentials": {
        "type": "oauth2",
        "description": "Assignr/OAuth 2.0 Client Credentials Code Flow",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://app.assignr.com/oauth/token",
            "scopes": {
              "read": "Read data",
              "write": "Write data",
              "licensing": "Access to Licensing data"
            }
          }
        }
      },
      "assignr_oauth2_auth_code_flow": {
        "type": "oauth2",
        "description": "Assignr/OAuth 2.0 Authorization Code Flow",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://app.assignr.com/oauth/authorize",
            "tokenUrl": "https://app.assignr.com/oauth/token",
            "scopes": {
              "read": "Read data",
              "write": "Write data",
              "bank": "Add and remove bank accounts",
              "mobile": "Account actions for official Assignr mobile app"
            }
          }
        }
      }
    },
    "schemas": {
      "FreeDateRepresenter": {
        "type": "object",
        "properties": {
          "id": {
            "description": "",
            "type": "string",
            "example": 123
          },
          "date": {
            "description": "",
            "type": "string",
            "example": "2020-12-01"
          },
          "all_day": {
            "description": "",
            "type": "boolean",
            "example": false
          },
          "description": {
            "description": "",
            "type": "string",
            "example": "Noon-6p"
          },
          "start_time": {
            "description": "",
            "type": "string",
            "example": "12:00 PM"
          },
          "end_time": {
            "description": "",
            "type": "string",
            "example": "6:00 PM"
          },
          "created": {
            "description": "",
            "type": "string",
            "example": "2020-10-21T16:37:11.000-04:00"
          },
          "updated": {
            "description": "",
            "type": "string",
            "example": "2020-10-21T16:37:11.000-04:00"
          },
          "_links": {
            "type": "object",
            "properties": {
              "self": {
                "type": "object",
                "properties": {
                  "resource-type": {
                    "description": "Resource Type",
                    "type": "string",
                    "example": "availability"
                  },
                  "href": {
                    "description": "URI for the given resource",
                    "type": "string",
                    "example": "https://api.assignr.com/api/v2/availability/123.json"
                  }
                }
              }
            }
          }
        },
        "description": "FreeDateRepresenter model"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 96,
      "1": 18,
      "2": 244,
      "3": 62,
      "4": 88,
      "5": 249,
      "6": 244,
      "7": 0,
      "8": 129,
      "9": 148,
      "10": 5,
      "11": 110
    }
  }
}
```