API Reference
Home

v1/mcp/import/describe_schema

get
https://shyftplan.com/api/v1/mcp/import/describe_schema

Describe the field contract and reference data for staging an import.

Query Params
string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

string
required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

int32
required
≥ 1

ID of a shyftplan account.

entities[]
array of strings

Restrict the answer to these entities. Defaults to all of them.

entities[]
Allowed:
Responses
200

Entity contracts plus the tenant reference catalog

401

401 Unauthorized

403

Forbidden - caller cannot manage this company

404

Company not found

Updated about 5 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated about 5 hours ago

Did this page help you?