Skip to main content
GET
/
schemas
/
{id}
Get schema
curl --request GET \
  --url https://api.sftpsync.io/schemas/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "version": 123,
  "description": "<string>",
  "fields": [
    {
      "name": "<string>",
      "type": "<string>",
      "required": true,
      "description": "<string>",
      "validation": {}
    }
  ],
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

Response

Schema

id
string
required
name
string
required
fields
object[]
required
workspaceId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
version
integer
description
string