1. Home
  2. Docs
  3. API
  4. REST API basics
  5. URI breakdown

URI breakdown

The URI parts are as follow https://x.apigoat.com/p/{$projectName}/api/v1/${model}[[/${action}][/${id}]]

Base url: https://x.apigoat.com/p/{$projectName}/api/v1/

${model} would be the CamelCase of the table or the optional model name.

${action} (optional) will be use for special behavior like getting/reading (file/open) a file.

${id} (optional) use to request an action on a particular Id.

How can we help?

Leave a Reply