REST API - Fieldnode Developer

Fieldnode API is a REST + JSON HTTP API, published as an OpenAPI 3.1 specification — clients can be generated for any language from that spec.

API model

Source of truth: OpenAPI 3.1 specification — download openapi.json.
Transport: HTTPS with JSON request and response bodies.
URL shape: Resource paths under /v1/…, plus :batch-get collection actions (e.g. POST /v1/orgs:batch-get).
Authentication: PAT bearer token — see Authentication.
Errors: Stable JSON envelope across every endpoint — see Errors.

The canonical machine-readable contract is the OpenAPI document. Use it to:

Browse endpoints, parameters, and response models in the API Reference section of these docs.
Generate a typed client in your language with any OpenAPI-compatible tool, for example:
- openapi-typescript or @hey-api/openapi-ts for TypeScript.
- oapi-codegen for Go.
- openapi-generator for Java, Python, C#, Ruby, and more.

There are currently no Fieldnode-published SDKs — generate the client that fits your stack from the OpenAPI spec.

Every endpoint accepts and returns JSON. A minimal curl against the Lab environment:

curl https://api.lab.fieldnode.dev/v1/parts \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer pat_your_personal_access_token'

Environment base URL: Lab, Sandbox, or Production (see Introduction).
Authorization header: Authorization: Bearer pat_<your_token>.
Accept: application/json (and Content-Type: application/json for requests with a body).
Timeouts and retries: configure client defaults for network resiliency. Retry on 5xx and 429 with backoff; do not retry on 4xx other than 429.
Error handling: parse the JSON error envelope and branch on its code — see Errors.