Retrieve policy details by ID

GET /api/v1/policy/{id}

Fetches details of a policy based on the given ID. The policy must belong to the authenticated user's organization or be under its parent organization.

Path parameters

id string Required

The unique policy number identifier

Responses

200 application/json

Policy details retrieved successfully
Hide response attributes Show response attributes object
- number integer
  
  Unique policy number
- coverage object
  
  Coverage details of the policy
  
  Additional properties are allowed.
- charges array[object]
  
  List of charges associated with the policy
  
  Additional properties are allowed.
- organization object
  
  Organization details associated with the policy
  
  Additional properties are allowed.
401

Not authenticated. The user must be logged in to access this endpoint.
404

Not Found. The policy does not exist or the user does not have permission to access it.

GET /api/v1/policy/{id}

curl \
 --request GET 'https://ark.collegecanine.com/api/v1/policy/{id}'

Response examples (200)

{
  "number": 42,
  "coverage": {},
  "charges": [
    {}
  ],
  "organization": {}
}