# Returns a VisitV1 by ID.

Returns the VisitV1 identified by the path parameter. **404** (`VisitV1 not found`) when the resource is missing or not accessible in the organization context.

Endpoint: GET /v1/visits/{visitId}
Version: 191.0.3
Security: bearerAuth, oAuthSandbox

## Security:

  - `bearerAuth` (unknown)
    http bearer JWT

  - `oAuthSandbox` (unknown)
    oauth2

## Path parameters:

  - `visitId` (integer, required)
    ID of the visit to retrieve

## Query parameters:

  - `responseFields` (string)
    A URL-encoded, comma-delimited list of field names to include in the response data. Additionally, the following values are also supported:

ALL - Returns all field names.

## Header parameters:

  - `Organization-ID` (string, required)
    Organization context for the request. Must match the organization authorized by the access token.

## Response 200:

  - `200` (unknown)
    The request was successful

## Response 200 fields (application/json):

  - `data` (object)
    This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide
    Example: {"descProceduresOrder":true,"procedures":[{"id":12345,"url":"https://api.example.com/models/12345","type":"ExampleModelType"}],"txCase":{"id":12345,"url":"https://api.example.com/models/12345","type":…

  - `data.id` (integer)

  - `data.type` (string)
    Resource type. Always `VisitV1`.
    Example: VisitV1

  - `data.duration` (integer)
    Visit length in minutes. Allowed range is 10–240. If omitted on create, the database default is 60.
    Example: 60

  - `data.sequence` (integer)
    Example: 0

  - `data.visitProceduresOrderType` (string)
    Procedure sort order. Optional on create; if omitted, the database default is TEETH.
    Enum: "TEETH", "CREATED", "CODE", "SURFACES", "DESCRIPTION", "PROVIDER", "AMOUNT", "CUSTOM"

  - `data.descProceduresOrder` (boolean, required)
    When true, sort procedures descending. Required on POST; omitting it returns 400.
    Example: true

  - `data.procedures` (array, required)
    Non-empty array of patient procedures. An empty array is rejected on create (`procedures should not be empty`).

  - `data.procedures.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.procedures.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.procedures.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `data.lastModified` (string)
    Example: 2018-07-09T19:00:00.000Z

  - `data.txCase` (object, required)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.txCase.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.txCase.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.txCase.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `data.appointment` (object)
    Linked appointment when this visit is scheduled; omitted or null otherwise.

  - `data.appointment.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.appointment.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.appointment.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `warnings` (array)

  - `warnings.code` (string)

  - `warnings.title` (string)

  - `warnings.description` (string)

  - `warnings.source` (string)

  - `errors` (array)

## Response 400:

  - `400` (unknown)
    The request was invalid or cannot be processed

## Response 401:

  - `401` (unknown)
    Authentication is required and has failed or has not been provided

## Response 403:

  - `403` (unknown)
    The request is understood, but it has been refused or access is not allowed

## Response 404:

  - `404` (unknown)
    VisitV1 not found

## Response 408:

  - `408` (unknown)
    The server timed out while processing the request

## Response 429:

  - `429` (unknown)
    Rate limit exceeded

## Response 500:

  - `500` (unknown)
    An unexpected error occurred

## Response 200 examples:

  - `default` (unknown)