Skip to main content
GET
/
workspace
/
{workspace_id}
/
apigroup
/
{apigroup_id}
/
api
/
{api_id}
Retrieve a specific API endpoint by ID
curl --request GET \
  --url https://your-xano-instance.xano.io/api:meta/workspace/{workspace_id}/apigroup/{apigroup_id}/api/{api_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "created_at": "2023-04-19 21:01:32+0000",
  "updated_at": "2023-04-19 21:01:32+0000",
  "name": "API Test",
  "description": "My APIs description",
  "docs": "Documentation",
  "guid": "YE1fwVhQ-enRlc6Sb42Gqru58-0",
  "cache": {
    "active": true,
    "ttl": 3600,
    "input": true,
    "auth": true,
    "datasource": true,
    "ip": true,
    "headers": [
      ""
    ],
    "env": [
      "<string>"
    ]
  },
  "auth": {},
  "verb": "GET",
  "input": [
    ""
  ],
  "tag": [
    "example tag"
  ],
  "xanoscript": {
    "value": "<string>",
    "message": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
integer<int64>
required
​
apigroup_id
integer<int64>
required
​
api_id
integer<int64>
required

Query Parameters

​
include_draft
boolean
default:false
​
include_xanoscript
boolean
default:false

Response

Success!

​
id
integer<int64>
default:1
​
created_at
string<timestamptz>
default:2023-04-19 21:01:32+0000
​
updated_at
string<timestamptz>
default:2023-04-19 21:01:32+0000
​
name
string
default:API Test
​
description
string
default:My APIs description
​
docs
string
default:Documentation
​
guid
string
default:YE1fwVhQ-enRlc6Sb42Gqru58-0
​
cache
object
​
auth
object
​
verb
enum<string>
default:GET
Available options:
GET,
POST,
DELETE,
PUT,
PATCH,
HEAD
​
input
object[]
​
tag
string[]
​
xanoscript
object