v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB

Property Claim

Find property claims

get/v1/property_claims

Query parameters

assignment_identifierstring

The external assignment's identifier for this claim.

contractor_identifierstring

The contractor's identifier for this claim.

insurer_identifierstring

The insurance carrier's identifier for this claim.

policyholder_namestring

The name of the policyholder for this claim.

order'newest' | 'oldest'

Specifies the ordering of results.

If not specified, defaults to newest.

newest

Ordered by internal creation date in descending order (newest first).

oldest

Ordered by internal creation date in ascending order (oldest first).

limitinteger

Maximum number of results to return.

Maximum limit is '100'. If not specified, defaults to '50'.

afterstring jwt

If not specified, fetches the first page of results.

A string obtained from previous API queries. Used to fetch the next page of results.

See the after key in the response for more information.

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Response

A list of PropertyClaims visible to the authenticated token.

Example response

{
  "list": [
    {
      "organization_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
      "date_claim_created": "1969-07-20",
      "date_of_loss": "1969-07-20"
    }
  ]
}