Requesting a Product

Get a single product by ID

get

Returns an array containing a single product object matching the given product ID.

Authorizations
AuthorizationstringRequired

JWT access token obtained from POST /authorize. Tokens expire after 15 minutes.

Path parameters
product-idstringRequired

Unique product identifier (UUID or numeric ID).

Responses
chevron-right
200

Array containing the requested product.

application/json

A document, map, report, or folder associated with a hazard.

app_IDsstring · nullableOptional

Associated application IDs.

comment_TextstringOptional

Comment on the product.

datastring · nullableOptional

Inline data payload, if any.

filenamestring · nullableOptional

Original filename, if applicable.

hazard_IDintegerOptional

Associated hazard ID.

Example: 203575
is_HiddenstringOptional

Whether the product is hidden (Y or N).

Example: N
org_IDintegerOptional

Organisation ID.

org_IDsstringOptional

Comma-separated organisation IDs.

organization_acronymstring · nullableOptional

Acronym of the producing organisation.

parent_IDintegerOptional

Parent product ID (for folder hierarchy).

Example: 1756465
product_IDintegerOptional

Unique product identifier.

Example: 1756466
product_TypestringOptional

Product type code.

Example: FOLDER_PRODUCT
security_FlagstringOptional

Security classification flag.

Example: A
titlestringOptional

Product title.

Example: PDC (SA)
uuidstringOptional

Unique identifier.

user_IDstringOptional

User or system that created the product.

Example: DisasterAWARE (Automated)
product_urlstring · nullableOptional

URL to download or view the product.

suffixstringOptional

File suffix or type indicator.

Example: folder
create_DatestringOptional

Creation timestamp in epoch milliseconds.

Example: 1697157024387
update_DatestringOptional

Last update timestamp in epoch milliseconds.

Example: 1697222488323
timeline_DatestringOptional

Timeline display timestamp in epoch milliseconds.

Example: 1697222488323
update_UserstringOptional

User who last updated the product.

Example: ddp
geo_LocationsstringOptional

Geographic location metadata.

get
/products/{product-id}
circle-info

See Authorizing Requests page to get your accessToken.

Below is an example request with path parameters product-id=1153909

Last updated