Interop Data API

List all Orgs

get

/rostering/orgs

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs'

200

200

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

Orgs response

List all LEA-type Orgs

get

/rostering/leas

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/leas'

200

200

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

Orgs response

List all School-type Orgs

get

/rostering/schools

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/schools'

200

200

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

Orgs response

Find an Org by $sys.id

get

/rostering/orgs/{id}

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the object

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}'

200

404

200

{
  "data": {
    "$ext": {
      "ANY_ADDITIONAL_PROPERTY": {}
    },
    "id": "2a4a2e06-7755-43bb-9766-4f398079ef8c",
    "name": "Kimono School District"
  },
  "error": {
    "status": 1,
    "code": "text",
    "message": "text",
    "ext_message": "text",
    "details": "text"
  }
}

Org response

List Students that are members of an Org

get

/rostering/orgs/{id}/students

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Org

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/students'

200

404

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "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": "[e-mail]",
      "sex": "text",
      "dob": "2025-02-20",
      "aup": true,
      "grad_year": "text",
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z",
        "person_type": "text"
      },
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text",
          "$membership": null
        }
      ],
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "$membership": null,
            "org_type": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Persons

List Teachers that are members of an Org

get

/rostering/orgs/{id}/teachers

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Org

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/teachers'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "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": "[e-mail]",
      "sex": "text",
      "dob": "2025-02-20",
      "aup": true,
      "grad_year": "text",
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z",
        "person_type": "text"
      },
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text",
          "$membership": null
        }
      ],
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "$membership": null,
            "org_type": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Persons

List Courses that belong to an Org

get

/rostering/orgs/{id}/courses

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Org

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/courses'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$orgs": [],
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z"
      },
      "$sections": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Orgs

List Sections that belong to an Org

get

/rostering/orgs/{id}/sections

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Org

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/sections'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$org": null,
      "$teachers": [],
      "$students": [],
      "$course": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      },
      "$terms": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "term_type": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Sections

List Terms that belong to an Org

get

/rostering/orgs/{id}/terms

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Org

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/orgs/{id}/terms'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "name": "text",
      "description": "text",
      "start_date": "2025-02-20",
      "end_date": "2025-02-20",
      "status": "text",
      "$parent": null,
      "$children": [],
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z",
        "term_type": "text"
      }
    }
  ],
  "paging": {
    "next": "text"
  }
}

Terms response

Find an LEA-type Org by $sys.id

get

/rostering/leas/{id}

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the LEA

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/leas/{id}'

200

200

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

Org response

Get all Persons

get

/rostering/persons

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/persons'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "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": "[e-mail]",
      "sex": "text",
      "dob": "2025-02-20",
      "aup": true,
      "grad_year": "text",
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z",
        "person_type": "text"
      },
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text",
          "$membership": null
        }
      ],
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "$membership": null,
            "org_type": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Person

List all Student-type Persons

get

/rostering/students

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/students'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "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": "[e-mail]",
      "sex": "text",
      "dob": "2025-02-20",
      "aup": true,
      "grad_year": "text",
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z",
        "person_type": "text"
      },
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text",
          "$membership": null
        }
      ],
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "$membership": null,
            "org_type": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Person

List all Teacher-type Persons

get

/rostering/teachers

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/teachers'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "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": "[e-mail]",
      "sex": "text",
      "dob": "2025-02-20",
      "aup": true,
      "grad_year": "text",
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z",
        "person_type": "text"
      },
      "$sections": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text",
          "$membership": null
        }
      ],
      "$schools": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "$membership": null,
            "org_type": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Person

Find a Person by $sys.id

get

/rostering/persons/{id}

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Person to find

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/persons/{id}'

200

200

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "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": "[e-mail]",
  "sex": "text",
  "dob": "2025-02-20",
  "aup": true,
  "grad_year": "text",
  "$sys": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "school_year": 1,
    "created_at": "2025-02-20T19:06:56.240Z",
    "updated_at": "2025-02-20T19:06:56.240Z",
    "person_type": "text"
  },
  "$sections": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "label": "text",
      "$membership": null
    }
  ],
  "$schools": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "label": "text",
        "$membership": null,
        "org_type": "text"
      }
    }
  ]
}

Person response

List all Courses

get

/rostering/courses

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/courses'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$orgs": [],
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z"
      },
      "$sections": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Course

Find a Course by $sys.id

get

/rostering/courses/{id}

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Course to find

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/courses/{id}'

200

200

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "local_id": "text",
  "title": "text",
  "description": "text",
  "$orgs": [],
  "$sys": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "school_year": 1,
    "created_at": "2025-02-20T19:06:56.240Z",
    "updated_at": "2025-02-20T19:06:56.240Z"
  },
  "$sections": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "label": "text"
      }
    }
  ]
}

Course response

List all Sections

get

/rostering/sections

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/sections'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "$sys": null,
      "local_id": "text",
      "title": "text",
      "description": "text",
      "$org": null,
      "$teachers": [],
      "$students": [],
      "$course": {
        "$sys": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "label": "text"
        }
      },
      "$terms": [
        {
          "$sys": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "type": "text",
            "label": "text",
            "term_type": "text"
          }
        }
      ]
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Section

Find a Section by $sys.id

get

/rostering/sections/{id}

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Section to find

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/sections/{id}'

200

200

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "$sys": null,
  "local_id": "text",
  "title": "text",
  "description": "text",
  "$org": null,
  "$teachers": [],
  "$students": [],
  "$course": {
    "$sys": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "label": "text"
    }
  },
  "$terms": [
    {
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "label": "text",
        "term_type": "text"
      }
    }
  ]
}

Section response

List all Terms

get

/rostering/terms

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/terms'

200

200

{
  "data": [
    {
      "$ext": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "name": "text",
      "description": "text",
      "start_date": "2025-02-20",
      "end_date": "2025-02-20",
      "status": "text",
      "$parent": null,
      "$children": [],
      "$sys": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "label": "text",
        "school_year": 1,
        "created_at": "2025-02-20T19:06:56.240Z",
        "updated_at": "2025-02-20T19:06:56.240Z",
        "term_type": "text"
      }
    }
  ],
  "paging": {
    "next": "text"
  }
}

Array of Terms

Find a Term by $sys.id

get

/rostering/terms/{id}

Authorizations

Path parameters

idstring · uuidrequired

$sys.id of the Term to find

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/rostering/terms/{id}'

200

200

{
  "$ext": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "name": "text",
  "description": "text",
  "start_date": "2025-02-20",
  "end_date": "2025-02-20",
  "status": "text",
  "$parent": null,
  "$children": [],
  "$sys": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "label": "text",
    "school_year": 1,
    "created_at": "2025-02-20T19:06:56.240Z",
    "updated_at": "2025-02-20T19:06:56.240Z",
    "term_type": "text"
  }
}

Term response

List all Grading Categories

get

/grades/gradingCategories

Authorizations

Query parameters

pageinteger · int32

Specify the page number (defaults to 0)

page_sizeinteger · int32

Specify the page_size (defaults to the maximum page size)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.us2.kimonocloud.com/v2/interop/data/grades/gradingCategories'

200

200

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

GradingCategory response