Set up an API key

An API key lets another system act within the permissions you give it. Use a separate key for each connection so you can recognise it and stop its access independently.

Create your key

1. Open Settings → Integrations.
2. On API keys, choose New API key or New key.
3. Add an optional name, such as “Lettings software”. A blank name is saved as “Untitled key”.
4. Select the permissions the connection needs.
5. Choose all owned properties or select individual properties.
6. Create the key and copy it into your other system's secure credential settings.

The complete key is shown only once. Letted keeps a shortened identifier in the list, but you cannot use that identifier to recover the secret. If you lose it, create a replacement and revoke the old key.

Choose permissions

View means the connection can read information. Create, add, update and invite allow it to make changes. Selecting a write permission does not automatically select the matching view permission.

• View properties and rooms: find the correct property or room.
• Create and send agreements and forms: use a saved template or supply document text, fill custom fields, choose whether signatures are required and queue tenant notifications.
• View tenancies and agreements: read tenancy details, tenant membership and agreement status.
• Create tenancies and manage groups: create tenancies and manage their tenant membership.
• View tenants: read tenant details.
• Add, update and invite tenants: create or link tenants as part of a tenancy workflow, change their details or access, and request invitations.
• View tasks: read property tasks and their current status.
• Create property tasks: raise a task at a property.

For a complete tenant-group handover, you need both Create tenancies and manage groups and Add, update and invite tenants. Add the relevant view permissions so the connection can find records and check the result.

For a task-reporting connection, start with View properties and rooms, Create property tasks and View tasks.

Choose properties

All owned properties includes properties you add in future. Selected properties limits the key to the properties you choose now.

Access is always limited to the organisation that owns the key. If a tenant belongs to more than one property, a restricted key must cover all of that tenant's properties before it can change their contact details, access or invitation.

Check and stop a connection

The key list shows its creation date, last-used date, property access and expandable permissions. Last API activity shows the latest use across your keys. It does not mean every request succeeded.

Each key has a limit of 120 requests per minute. Requests can be refused if the connection sends too many at once.

To stop a key, open its actions menu and choose Revoke key. It can no longer authorise requests. API access is also suspended if the organisation loses paid-plan eligibility.

A prompt to choose permissions

Read these Letted guides first:
https://app.letted.com/docs/api-keys
https://app.letted.com/docs/api-reference

If you cannot open them, ask me to paste the pages rather than guessing.

I want a connection that [describe the job] in Letted.
Using these docs, suggest the smallest set of API key permissions it needs.
Explain each one without jargon. It should access only [my chosen properties].
List any extra permissions needed to check the result or receive updates.
Do not ask me to paste my key into this chat.

The technical permission names and authentication format are in the connection reference.