API

API Reference

Secure endpoints, examples, errors, pagination, and webhooks.

Overview

Secure, org-scoped API for projects, indicators, submissions, users/roles, and exports.

Authentication

Use a bearer token on every request.

Authorization: Bearer <ACCESS_TOKEN>

Base URL & environments

  • Production: https://api.resulynx.com/v1
  • Staging: https://staging-api.resulynx.com/v1

Endpoints

Projects

  • GET /projects
  • POST /projects
  • GET /projects/{id}
  • PATCH /projects/{id}

Indicators

  • GET /projects/{id}/indicators
  • POST /projects/{id}/indicators
  • GET /indicators/{id}/results

Data collection

  • GET /forms
  • POST /submissions
  • GET /submissions

Users/Roles

  • GET /users
  • POST /roles
  • POST /users/{id}/assign-role

Reports

  • POST /reports/export
  • GET /reports/{id}

Request/Response examples

GET /projects
200 OK [{"id":"prj_01","name":"Foresta360","status":"active"}]
POST /submissions {"form_id":"frm_10","project_id":"prj_01","data":{"gps":{"lat":-3.37,"lng":36.69}}}

Errors, rate limits, pagination

{"error":{"code":"permission_denied","message":"No access.","request_id":"req_..."}}

Pagination supports page/page_size (or cursor where enabled). Rate limits are plan-based.

Webhooks

If enabled, configure in Settings → Integrations for events like submissions received or exports completed.