Platform API
Get a list of Accounts
Authorizations
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
Accounts response
application/json
Responseall of
get
GET /v2/platform/accounts HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Basic username:password
Accept: */*
200
Accounts response
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"type": "kimono",
"status": "pending_activation",
"address": "text",
"address_2": "text",
"city": "text",
"state": "text",
"postal_code": "text",
"country": "text",
"nces_district_id": "text",
"nces_school_id": "text",
"ipeds_id": "text",
"region": "text",
"time_zone": "text"
}
]
}
Authorizations
Body
idstring · uuidOptional
namestringOptional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
addressstringOptional
address_2stringOptional
citystringOptional
statestringOptional
postal_codestringOptional
countrystringOptional
nces_district_idstringOptional
nces_school_idstringOptional
ipeds_idstringOptional
regionstringOptional
time_zonestringOptional
Responses
200
Success
application/json
Responseall of
400
Bad Request
application/json
post
POST /v2/platform/accounts HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 311
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"type": "kimono",
"status": "pending_activation",
"address": "text",
"address_2": "text",
"city": "text",
"state": "text",
"postal_code": "text",
"country": "text",
"nces_district_id": "text",
"nces_school_id": "text",
"ipeds_id": "text",
"region": "text",
"time_zone": "text"
}
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"type": "kimono",
"status": "pending_activation",
"address": "text",
"address_2": "text",
"city": "text",
"state": "text",
"postal_code": "text",
"country": "text",
"nces_district_id": "text",
"nces_school_id": "text",
"ipeds_id": "text",
"region": "text",
"time_zone": "text"
}
}
Authorizations
Responses
200
Account response
application/json
Responseall of
get
GET /v2/platform/accounts/self HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Basic username:password
Accept: */*
200
Account response
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"type": "kimono",
"status": "pending_activation",
"address": "text",
"address_2": "text",
"city": "text",
"state": "text",
"postal_code": "text",
"country": "text",
"nces_district_id": "text",
"nces_school_id": "text",
"ipeds_id": "text",
"region": "text",
"time_zone": "text"
}
}
Authorizations
Path parameters
idstring · uuidRequired
id of the object
Responses
200
Account response
application/json
Responseall of
get
GET /v2/platform/accounts/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Basic username:password
Accept: */*
200
Account response
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"type": "kimono",
"status": "pending_activation",
"address": "text",
"address_2": "text",
"city": "text",
"state": "text",
"postal_code": "text",
"country": "text",
"nces_district_id": "text",
"nces_school_id": "text",
"ipeds_id": "text",
"region": "text",
"time_zone": "text"
}
}
Authorizations
Path parameters
idstring · uuidRequired
id of the object
Body
idstring · uuidOptional
namestringOptional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
addressstringOptional
address_2stringOptional
citystringOptional
statestringOptional
postal_codestringOptional
countrystringOptional
nces_district_idstringOptional
nces_school_idstringOptional
ipeds_idstringOptional
regionstringOptional
time_zonestringOptional
Responses
204
No content
patch
PATCH /v2/platform/accounts/{id} HTTP/1.1
Host: api.us2.kimonocloud.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 311
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"type": "kimono",
"status": "pending_activation",
"address": "text",
"address_2": "text",
"city": "text",
"state": "text",
"postal_code": "text",
"country": "text",
"nces_district_id": "text",
"nces_school_id": "text",
"ipeds_id": "text",
"region": "text",
"time_zone": "text"
}
204
No content
No content
Last updated
Was this helpful?