Sign in
Sessions

Get session by ID

Changed on

Retrieve a specific therapy session by its UUID

get/sessions/{id}

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/sessions/{id}
  • Auth: none declared

Path parameters

idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

UUID of the Session to retrieve

Response

Session found successfully

idstring uuid required

Unique identifier for the session

session_namestring required

Name of the Session

start_datetimestring date-time required

Start date and time of the session

end_datetimestring date-time required

End date and time of the session

therapist_idstring uuid required

ID of the therapist conducting the session

session_parent_idstring uuid required

UUID of the parent session (for recurring sessions)

notesstring nullable

Session notes (optional)

locationstring nullable

Session location (optional)

created_atstring date-time nullable

When the session record was created

updated_atstring date-time nullable

When the session record was last updated

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "session_name": "Fluency work with Florence",
  "start_datetime": "2024-01-15T14:30:00Z",
  "end_datetime": "2024-01-15T15:30:00Z",
  "therapist_id": "987fcdeb-51a2-43d1-9f4c-123456789abc",
  "session_parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "notes": "Patient showed improvement in anxiety management techniques",
  "location": "To the land where the honey runs...",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:35:00Z",
  "repetition": {
    "recur_start": "2025-09-13T17:19:00Z",
    "recur_end": "2025-11-13T17:19:00Z",
    "every_n_weeks": 2,
    "days": [
      1,
      3,
      5
    ]
  }
}

Changes

  • c6cc4b5b44ceRevision changes
    • ●

      removed the optional property from the response with the status

    • ○

      added the optional property to the response with the status

  • 6b13211b9245Revision changes
    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status