HTTP quickstart

Getting started

HTTP quickstart

Get started with the Lightfield API using HTTP.

This guide walks you through making your first request to the Lightfield API using HTTP and curl.

Get an API key

An API key can be created in Lightfield settings (admin only).

When creating the key, select the scopes your integration needs.

For the test call just below, you’ll need accounts:read.

Make your first request

List one account to verify your key and scope:

curl "https://api.lightfield.app/v1/accounts?limit=1" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Lightfield-Version: 2026-03-01"

Replace YOUR_API_KEY with your key (sk_lf_...). With limit=1, you will get at most one account back. The response is JSON. A successful response will look like:

{
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "fields": {
        "foo": {
          "value": "string",
          "valueType": "valueType"
        }
      },
      "httpLink": "httpLink",
      "relationships": {
        "foo": {
          "cardinality": "cardinality",
          "objectType": "objectType",
          "values": [
            "string"
          ]
        }
      }
    }
  ],
  "object": "object",
  "totalCount": 1
}

To fetch more results, use the limit and offset query parameters. See List methods to learn how to handle paginated requests.

If you get 401 Unauthorized, check that the key is correct and in the Authorization: Bearer ... header. If you get 403 Forbidden, your key may not have the required scope (e.g. accounts:read for listing accounts). For more on error responses and how to handle them, see Errors.

Next steps

Objects in Lightfield — Overview of object types (accounts, contacts, opportunities, and more) and how they relate.
API Reference — Full list of operations, request parameters, and response schemas.
Rate limits — Request limits and how to handle 429 responses.
Idempotency — Safe retries for create and update operations.