Need to manage API keys, view logs, or check usage?Open the Developer portal →

List materials

Search and list materials in the Circa library.

GET/public/materials

Query parameters

ParameterTypeDescription
searchstringCase-insensitive substring match on material name.
limitintegerdefault: 25Number of records to return. 1–100.
offsetintegerdefault: 0Records to skip.
pulledbooleandefault: falseWhen true, restrict to materials the authenticated user has already pulled. Equivalent to calling /public/materials/pulled.

Response

200OK
{
  "items": [
    {
      "id": "m_8c2…",
      "name": "Polyethylene, high density, granulate",
      "source": "Ecoinvent 3.10",
      "sourceOrganization": "ecoinvent",
      "functionalUnit": "kg",
      "compartment": "Production",
      "datePublished": "2024-09-01",
      "revealed": false
    }
  ],
  "total": 12453
}

Example

curl -s 'https://api.circa.ai/public/materials?search=polyethylene&limit=10' \
  -H 'x-api-key: circa_live_xxx' \
  -H 'x-team-id: TEAM_ID_FROM_OVERVIEW' \
  -H 'Circa-Version: 2026-05-11.obsidian'