People

Everyone on file, with tenants and guarantors split out

One page of contacts by id, each carrying the resolved name a screen should print. kind narrows the whole collection through the index the table already carries. The two subsets a letting screen always wants next, tenants and guarantors, come back filtered from the rows of this page, so a consumer never re-implements the rule for what counts as one; wanting all of them is a ?kind= page of its own.

get/api/v1/contacts

Request

  • Base URL: http://localhost:5180
  • URL: http://localhost:5180/api/v1/contacts
  • Auth: API key in cookie better-auth.session_token

Query parameters

kind'tenant' | 'guarantor' | 'applicant' | 'guest' | 'contractor' | 'supplier' | 'owner' | 'representative' | 'other'

Only contacts of this kind. Read through the contacts_kind_idx index, so it pages the whole collection rather than filtering one page.

limitinteger

How many contacts to return, by id. 1–1000, default 50.

offsetinteger

How many contacts to skip before counting limit. Default 0. Page with offset = offset + limit until a page comes back shorter than limit.

Response

A page of contacts, plus the tenant and guarantor subsets of it.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.