Skip to main content
GET
List Records

Authorizations

Authorization
string
header
required

Your account's API key, sent as Authorization: Bearer <your API key>. Keys are issued per environment, so a staging key will not work against production.

Query Parameters

recordType
string
required

Record type to return, URI-encoded, such as Log or Preliminary Damage Assessment. Must match a record type configured for your account; the available types vary by account, so check with your customer success manager.

Example:

"Preliminary Damage Assessment"

createdFrom
string<date-time>

Return only records created strictly after this ISO 8601 timestamp. Use it to sync incrementally.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2024-03-01T00:00:00.000Z"

page
integer

1-based page number. List endpoints return 25 results per page.

Required range: x >= 1
Example:

1

externalSystemId
string

Return only items your system recorded under this identifier. Files and SI/SD records enforce uniqueness, so those match at most one; Log records do not. It can be set when creating or updating the item, or by an integration with an external system such as Accela.

Minimum string length: 1
Example:

"EC-2024-0417"

Response

Success. errors is empty.

errors
object[]
required

Empty when the request succeeded. Otherwise one entry per failure, and the resource fields on the response are empty: null for single resources, [] for lists, with pageInfo omitted.

Example:
records
object[]
required

Up to 25 records for the requested page.

pageInfo
object

Pagination metadata for a list response. Present whenever the request succeeded, and omitted when it failed validation.

Example: