Retrieve organization details

GET /api/v1/organization/{id}

Retrieves details of an organization by its ID. The requesting user must be authenticated and either own the organization or be a parent organization.

Path parameters

  • id string Required

    The unique identifier of the organization

Responses

  • 200 application/json

    Organization details retrieved successfully

    Hide response attributes Show response attributes object
    • id string

      Unique identifier of the organization

    • name string

      Name of the organization

    • parentId string

      Identifier of the parent organization, if applicable
  • 401

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

  • 404

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

GET /api/v1/organization/{id} 
curl \
 -X GET https://ark.collegecanine.com/api/v1/organization/{id}
Response examples (200) 
{
  "id": "string",
  "name": "string",
  "parentId": "string"
}