HTTP quickstart

List one account with curl to check your API key and scope.

Get an API key

An owner or admin can create an API key. See Authenticate API requests for how requests use the key.

Select the scopes your integration needs. This example needs accounts:read.

Make your first request

Set LIGHTFIELD_API_KEY to your key (sk_lf_...), then list one account to verify your key and scope:

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

With limit=1, you get at most one account. An empty data list is still a successful response when no readable accounts match. Inspect the record’s ID and fields in data; this excerpt shows a matching account:

{
  "data": [
    {
      "id": "acc_northwind",
      "fields": {
        "$name": { "valueType": "TEXT", "value": "Northwind Robotics" }
      }
    }
  ]
}

Use the list accounts reference for the complete response schema.

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). See Errors for error handling and retry guidance.

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.