Skip to content
Docs
Select language:English

/api/v1/floor-plans/{id}

GET
/api/v1/floor-plans/{id}
curl --request GET \
  --url https://example.com/api/v1/floor-plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
string
Allowed values: reading ready failed off applied discarded
turn
required
integer
>= -9007199254740991 <= 9007199254740991
keepPlan
required
boolean
createdAt
required
string
read
required
Any of:
object
status
required
string
Allowed values: queued running succeeded failed paused_budget waiting_provider no_provider superseded
reason
required
string | null
pausedUntil
required
string | null
attempt
required
integer
>= -9007199254740991 <= 9007199254740991
file
required
Any of:
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
attachmentId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
mime
required
string
image
required
Any of:
object
w
required
integer
>= -9007199254740991 <= 9007199254740991
h
required
integer
>= -9007199254740991 <= 9007199254740991
answer
required
Any of:
drafts
required
Any of:
Example
{
  "status": "reading",
  "read": {
    "status": "queued"
  }
}