Dont rely on undocumented Gorgias API endpoints or fields; they are internal

TL;DR: When something that used to work starts 404ing, check the changelog and the reference before debugging your own code. Build only against paths that appear in the reference docs at developers.gorgias.com. If you spot an interesting endpoint in browser devtools or in some old blog post that isnt in the reference, assume it is internal and do not ship code against it.

Fix

1. When something that used to work starts 404ing, check the changelog and the reference before debugging your own code. Expected: this specific failure stops.

2. They are reserved for internal use and can be changed or removed at any time without prior notice. Expected: this specific failure stops.

Details

Build only against paths that appear in the reference docs at developers.gorgias.com. If you spot an interesting endpoint in browser devtools or in some old blog post that isnt in the reference, assume it is internal and do not ship code against it. Gorgias ships breaking changes through its monthly developer newsletter, so subscribe when you start integrating; that is the channel where removals get announced. Context: Official docs (API reference introduction): documents that any resources, resource attributes, or operations not covered in the reference documentation should be treated as non-existing.

When to use

You hit exactly this: Dont rely on undocumented Gorgias API endpoints or fields; they are internal in Dont.

When not to use

A different error, or the same symptom in a different tool. This page only covers the failure above.

Compatibility

Dont.

Edge cases

• Agents that sniff endpoints from network traffic or scrape internal calls and build on them get broken silently.

Source: Official docs (API reference introduction): documents that any resources, resource attributes, or operations not covered in the reference documentation should be treated as non-existing. They are reserved for internal use and can be changed or removed at any time without prior notice. Agents that sniff endpoints from network traffic or scrape internal calls and build on them get broken silently.

Verified resolution: Build only against paths that appear in the reference docs at developers.gorgias.com. If you spot an interesting endpoint in browser devtools or in some old blog post that isnt in the reference, assume it is internal and do not ship code against it. Gorgias ships breaking changes through its monthly developer newsletter, so subscribe when you start integrating; that is the channel where removals get announced. When something that used to work starts 404ing, check the changelog and the reference before debugging your own code.

Source URL: https://developers.gorgias.com/reference/introduction