API Reference

Project List

get
https://www.coohom.com/api/saas/openapi/design/list

With project list, you will have a overview of project information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response

Param NameRequiredTypeDescription
planIdtrueStringId of floor plan.
designIdfalseStringId of design.
commNametrueStringThe name of floor community.
statustrueIntIf the project is under decoration stage, return 1. If the project is under floor plan stage, return 0.
citytrueStringThe city of the floor.
nametrueStringFloor Name.
srcAreatrueFloatThe building area of the floor, in square meter unit.
specNametrueStringThe type of the floor.
areatrueFloatThe carpet area of the floor.
planPictrueStringThe URL of floor picture.
coverPictrueStringThe URL of cover picture.
createdtrueLongCreated time of the plan, at the millisecond level.
modifiedTimetrueLongModified time of the plan, at the millisecond level.
tagIdfalseStringCatalog Id of the plan.
designPanoUrlfalseStringThe URL of Plan Panorama.
descfalseStringThe description of plan.
Query Params
string
required

identity id of your user

int32
required

the offset from the resource list, starting at 0

int32
required

quantity cap for one request.
In terms of data security and performance, the maximum num limit is 50.
If there is a need to pull more data, please initiate multiple requests.
If the amount of remaining data is less than num, all remaining data will be returned.

int32

The default is to invert projects according to the creation time.
Value 0 is the same as default, and value 1 is according to the last modification time.

string

If this field is set, the project name will be fuzzily matched with this word.

Responses

Updated almost 5 years ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 5 years ago