Frequently Asked Questions

Is the API versioned?

The API is currently unversioned and we evolve it additively: new fields, endpoints and filters may appear at any time, but we treat removing or renaming existing fields as breaking and avoid it. Build your client to ignore unknown fields.

What format are IDs?

All record IDs are ULIDs - 26-character, lexicographically sortable strings like 01j2xw6ykq3f8p9r0v5m7n8s4t. Treat them as opaque strings.

Can I download the OpenAPI specification?

Yes - the complete spec is at /openapi/growee-api.json. Use it to generate typed clients (e.g. with openapi-typescript or openapi-generator) or to import the API into Postman/Insomnia.

Why is a field missing from my response?

Some fields are gated by permissions (their descriptions in the reference say so - e.g. billing rates require payroll access). When your API key lacks the permission, gated fields are omitted from responses rather than returned as null.

Why do I get 403 on an endpoint the reference documents?

Your API key is missing the permission scope that endpoint requires, or the user who created the key lost that permission. Scopes are set when creating the key under Settings → Integrations → API Keys.

Can I add custom fields to records?

Yes. Define fields via the Custom Fields endpoints - each definition targets one entity type (lead, client, client_contact or employee) and gets an immutable slug. Values are then read and written through the custom_fields attribute on those records:

{
  "first_name": "Sarah",
  "custom_fields": { "t-shirt-size": "M", "preferred-office-day": "Tuesday" }
}

Is there a sandbox environment?

There is no separate sandbox. We recommend creating a dedicated test workspace for development so experiments never touch production data.

Do you support webhooks?

Not yet - webhooks are on the roadmap. Today, poll list endpoints using filters (for example a created_at/updated_at range) within the rate limits. Tell us about your use case via contact; it helps us prioritize.

Are there official SDKs?

Not yet. The API follows strict conventions (bearer auth, uniform envelopes, documented validation), so generated clients from the OpenAPI spec work well in the meantime.

What timezone are dates in?

Timestamps are ISO 8601 in UTC. Date-only fields (like a timesheet’s date) are calendar dates without timezone.

How do I report a bug or request an endpoint?

Email support@growee.net or use the contact form. Include the request path, response status, and your workspace subdomain (never your API key).