Interop Data API

List all Orgs

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Orgs response

application/json

get

/rostering/orgs

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/orgs HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Orgs response

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
      "name": "Kimono School District"
    }
  ]
}

List Tasks

get

Get the next batch of Tasks for the authenticated actor. The number of Tasks returned is determined by Kimono and may change from time to time. See Tasks for details.

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

tenant_idstring · uuidOptional

Specify the tenant_id to restrict this operation to

schemastring · enumOptional

Specify the Task Schema to use for this operation

Possible values:

driverstringOptional

Restrict Tasks to a specific Driver by name

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Tasks response

application/json

get

/tasks

HTTPcURLJavaScriptPython

GET /v2/interop/data/tasks HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Tasks response

{
  "data": [
    {
      "lifecycle_event": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "action": "TENANT_INSTALLED"
      },
      "sync_event": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "action": "SYNC_START",
        "group_id": "text",
        "origin": "initial"
      },
      "data_event": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "action": "ADD",
        "object_id": "text",
        "object_type": "text",
        "group_id": "text",
        "app_id": "text",
        "label": "text",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "changes": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "authenticate": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "session_id": "text"
      },
      "grades_export": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "grades_query": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "request": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "schema": "text",
      "type": "undefined"
    }
  ]
}

Acknowledge Task

put

Each Task that is returned from listTasks must be acknowledged to remove it from the Task Queue. If a Task is not acknowledged in a timely fashion Kimono may consider it to have timed-out and will return it in the next listTasks response for an Integration tenant. See Tasks for details.

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

id of the Task to acknowledge

Body

application/json

task_idstring · UUIDOptional

Task ID to acknowledge (Required if multiple TaskAcks are in a single request)

statusstring · enumOptional

Task processing status

Possible values:

messagestringOptional

Optional message to record and display in Kimono.

$sys.app_idstringOptional

Responses

200

Task acknowledged successfully

No content

404

Task not found

put

/tasks/{id}/ack

HTTPcURLJavaScriptPython

PUT /v2/interop/data/tasks/{id}/ack HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "task_id": "text",
  "status": "success",
  "message": "text",
  "$sys.app_id": "text",
  "error": null,
  "problem": null,
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

No content

Acknowledge Tasks

put

Acknowledge a group of Tasks. Each Task that is returned from listTasks must be acknowledged to remove it from the Task Queue. If a Task is not acknowledged in a timely fashion Kimono may consider it to have timed-out and will return it in the next listTasks response for an Integration tenant. See Tasks for details.

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Bodyobject[]

application/json

task_idstring · UUIDOptional

Task ID to acknowledge (Required if multiple TaskAcks are in a single request)

statusstring · enumOptional

Task processing status

Possible values:

messagestringOptional

Optional message to record and display in Kimono.

$sys.app_idstringOptional

Responses

200

All Tasks acknowledged successfully

No content

404

One or more Tasks not found

put

/tasks/ack

HTTPcURLJavaScriptPython

PUT /v2/interop/data/tasks/ack HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

[
  {
    "task_id": "text",
    "status": "success",
    "message": "text",
    "$sys.app_id": "text",
    "error": null,
    "problem": null,
    "params": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

No content

List Tasks (Admin)

get

List Tasks for the authenticated actor. See Tasks for details.

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

schemastring · enumOptional

Specify the Task Schema to use for this operation

Possible values:

driverstringOptional

Restrict Tasks to a specific Driver by name

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Tasks response

application/json

get

/tasks/admin

HTTPcURLJavaScriptPython

GET /v2/interop/data/tasks/admin HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Tasks response

{
  "data": [
    {
      "lifecycle_event": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "action": "TENANT_INSTALLED"
      },
      "sync_event": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "action": "SYNC_START",
        "group_id": "text",
        "origin": "initial"
      },
      "data_event": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "action": "ADD",
        "object_id": "text",
        "object_type": "text",
        "group_id": "text",
        "app_id": "text",
        "label": "text",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "changes": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "authenticate": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        },
        "session_id": "text"
      },
      "grades_export": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "grades_query": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "request": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
        "sequence": 1,
        "created_at": "2025-12-27T12:09:39.021Z",
        "data": {
          "ANY_ADDITIONAL_PROPERTY": {}
        }
      },
      "schema": "text",
      "type": "undefined"
    }
  ]
}

Acknowledge Task (Admin)

put

Each Task that is consumed by the client must be acknowledged to remove it from the Task Queue.

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

id of the Task to acknowledge

Body

application/json

task_idstring · UUIDOptional

Task ID to acknowledge (Required if multiple TaskAcks are in a single request)

statusstring · enumOptional

Task processing status

Possible values:

messagestringOptional

Optional message to record and display in Kimono.

$sys.app_idstringOptional

Responses

200

Task acknowledged successfully

No content

404

Task not found

put

/tasks/admin/{id}/ack

HTTPcURLJavaScriptPython

PUT /v2/interop/data/tasks/admin/{id}/ack HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "task_id": "text",
  "status": "success",
  "message": "text",
  "$sys.app_id": "text",
  "error": null,
  "problem": null,
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

No content

Acknowledge Tasks (Admin)

put

Acknowledge a group of Tasks. Each Task that is consumed by the client must be acknowledged to remove it from the Task Queue.

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Bodyobject[]

application/json

task_idstring · UUIDOptional

Task ID to acknowledge (Required if multiple TaskAcks are in a single request)

statusstring · enumOptional

Task processing status

Possible values:

messagestringOptional

Optional message to record and display in Kimono.

$sys.app_idstringOptional

Responses

200

All Tasks acknowledged successfully

No content

404

One or more Tasks not found

put

/tasks/admin/ack

HTTPcURLJavaScriptPython

PUT /v2/interop/data/tasks/admin/ack HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

[
  {
    "task_id": "text",
    "status": "success",
    "message": "text",
    "$sys.app_id": "text",
    "error": null,
    "problem": null,
    "params": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

No content

Find a Task

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

id of the Task

Responses

200

Task response

application/json

404

Task not found

get

/tasks/admin/{id}

HTTPcURLJavaScriptPython

GET /v2/interop/data/tasks/admin/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "lifecycle_event": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "sequence": 1,
      "created_at": "2025-12-27T12:09:39.021Z",
      "action": "TENANT_INSTALLED"
    },
    "sync_event": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "sequence": 1,
      "created_at": "2025-12-27T12:09:39.021Z",
      "action": "SYNC_START",
      "group_id": "text",
      "origin": "initial"
    },
    "data_event": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "sequence": 1,
      "created_at": "2025-12-27T12:09:39.021Z",
      "action": "ADD",
      "object_id": "text",
      "object_type": "text",
      "group_id": "text",
      "app_id": "text",
      "label": "text",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "changes": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "authenticate": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "sequence": 1,
      "created_at": "2025-12-27T12:09:39.021Z",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "session_id": "text"
    },
    "grades_export": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "sequence": 1,
      "created_at": "2025-12-27T12:09:39.021Z",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "grades_query": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "sequence": 1,
      "created_at": "2025-12-27T12:09:39.021Z",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "request": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenant_id": "123e4567-e89b-12d3-a456-426614174000",
      "sequence": 1,
      "created_at": "2025-12-27T12:09:39.021Z",
      "data": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "schema": "text",
    "type": "undefined"
  }
}

Delete Task (Admin)

delete

Delete a Task from the Task Queue. This operation is only available via the Task Admin API.

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

id of the Task

Responses

204

Success

delete

/tasks/admin/{id}

HTTPcURLJavaScriptPython

DELETE /v2/interop/data/tasks/admin/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Success

No content

List all LEA-type Orgs

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Orgs response

application/json

get

/rostering/leas

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/leas HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Orgs response

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
      "name": "Kimono School District"
    }
  ]
}

List all School-type Orgs

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Orgs response

application/json

get

/rostering/schools

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/schools HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Orgs response

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
      "name": "Kimono School District"
    }
  ]
}

Find an Org by $sys.id

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the object

Responses

200

Org response

application/json

404

Org not found

get

/rostering/orgs/{id}

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/orgs/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "$ext": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
    "name": "Kimono School District"
  }
}

List Students that are members of an Org

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Org

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Persons

application/json

404

Org not found

get

/rostering/orgs/{id}/students

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/orgs/{id}/students HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[email protected]",
      "sex": "text",
      "dob": "2025-12-27",
      "aup": true,
      "grad_year": "text",
      "$schools": [],
      "$sections": []
    }
  ]
}

List Teachers that are members of an Org

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Org

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Persons

application/json

get

/rostering/orgs/{id}/teachers

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/orgs/{id}/teachers HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Persons

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[email protected]",
      "sex": "text",
      "dob": "2025-12-27",
      "aup": true,
      "grad_year": "text",
      "$schools": [],
      "$sections": []
    }
  ]
}

List Courses that belong to an Org

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Org

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Orgs

application/json

get

/rostering/orgs/{id}/courses

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/orgs/{id}/courses HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Orgs

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$orgs": [],
      "$sections": []
    }
  ]
}

List Sections that belong to an Org

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Org

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Sections

application/json

get

/rostering/orgs/{id}/sections

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/orgs/{id}/sections HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Sections

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$terms": [],
      "$course": null,
      "$org": null,
      "$teachers": [],
      "$students": []
    }
  ]
}

List Terms that belong to an Org

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Org

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Terms response

application/json

get

/rostering/orgs/{id}/terms

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/orgs/{id}/terms HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Terms response

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "name": "text",
      "description": "text",
      "start_date": "2025-12-27",
      "end_date": "2025-12-27",
      "status": "text",
      "$parent": null,
      "$children": []
    }
  ]
}

Find an LEA-type Org by $sys.id

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the LEA

Responses

200

Org response

application/json

get

/rostering/leas/{id}

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/leas/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Org response

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
  "name": "Kimono School District"
}

Get all Persons

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Person

application/json

get

/rostering/persons

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/persons HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Person

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[email protected]",
      "sex": "text",
      "dob": "2025-12-27",
      "aup": true,
      "grad_year": "text",
      "$schools": [],
      "$sections": []
    }
  ]
}

List all Student-type Persons

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Person

application/json

get

/rostering/students

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/students HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Person

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[email protected]",
      "sex": "text",
      "dob": "2025-12-27",
      "aup": true,
      "grad_year": "text",
      "$schools": [],
      "$sections": []
    }
  ]
}

List all Teacher-type Persons

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Person

application/json

get

/rostering/teachers

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/teachers HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Person

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "state_id": "text",
      "name": {
        "last": "text",
        "first": "text",
        "middle": "text"
      },
      "address": {
        "line1": "text",
        "line2": "text",
        "line3": "text",
        "city": "text",
        "state": "text",
        "postal_code": "text",
        "country": "text"
      },
      "phone": "text",
      "email": "[email protected]",
      "sex": "text",
      "dob": "2025-12-27",
      "aup": true,
      "grad_year": "text",
      "$schools": [],
      "$sections": []
    }
  ]
}

Find a Person by $sys.id

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Person to find

Responses

200

Person response

application/json

get

/rostering/persons/{id}

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/persons/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Person response

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "$sys": null,
  "local_id": "text",
  "state_id": "text",
  "name": {
    "last": "text",
    "first": "text",
    "middle": "text"
  },
  "address": {
    "line1": "text",
    "line2": "text",
    "line3": "text",
    "city": "text",
    "state": "text",
    "postal_code": "text",
    "country": "text"
  },
  "phone": "text",
  "email": "[email protected]",
  "sex": "text",
  "dob": "2025-12-27",
  "aup": true,
  "grad_year": "text",
  "$schools": [],
  "$sections": []
}

List all Courses

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Course

application/json

get

/rostering/courses

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/courses HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Course

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$orgs": [],
      "$sections": []
    }
  ]
}

Find a Course by $sys.id

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Course to find

Responses

200

Course response

application/json

get

/rostering/courses/{id}

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/courses/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Course response

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "$sys": null,
  "local_id": "text",
  "title": "text",
  "description": "text",
  "$orgs": [],
  "$sections": []
}

List all Sections

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Section

application/json

get

/rostering/sections

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/sections HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Section

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$terms": [],
      "$course": null,
      "$org": null,
      "$teachers": [],
      "$students": []
    }
  ]
}

Find a Section by $sys.id

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Section to find

Responses

200

Section response

application/json

get

/rostering/sections/{id}

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/sections/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Section response

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "$sys": null,
  "local_id": "text",
  "title": "text",
  "description": "text",
  "$terms": [],
  "$course": null,
  "$org": null,
  "$teachers": [],
  "$students": []
}

List all Terms

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

Array of Terms

application/json

get

/rostering/terms

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/terms HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Array of Terms

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "name": "text",
      "description": "text",
      "start_date": "2025-12-27",
      "end_date": "2025-12-27",
      "status": "text",
      "$parent": null,
      "$children": []
    }
  ]
}

Find a Term by $sys.id

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Path parameters

idstring · uuidRequired

$sys.id of the Term to find

Responses

200

Term response

application/json

get

/rostering/terms/{id}

HTTPcURLJavaScriptPython

GET /v2/interop/data/rostering/terms/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Term response

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "$sys": null,
  "name": "text",
  "description": "text",
  "start_date": "2025-12-27",
  "end_date": "2025-12-27",
  "status": "text",
  "$parent": null,
  "$children": []
}

List all Grading Categories

get

Authorizations

OAuth2 & HttpBasic & bearerAuth

OAuth2clientCredentialsRequired

Token URL:

AuthorizationstringRequired

AuthorizationstringRequired

LTI JWT Authorization header using the Bearer scheme

Query parameters

pageinteger · int32Optional

Specify the page number (defaults to 0)

page_sizeinteger · int32Optional

Specify the page_size (defaults to the maximum page size)

Responses

200

GradingCategory response

application/json

get

/grades/gradingCategories

HTTPcURLJavaScriptPython

GET /v2/interop/data/grades/gradingCategories HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

GradingCategory response

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "name": "text",
      "$term": null,
      "$section": null,
      "$schools": null
    }
  ]
}