Account

Read the authenticated Screpy account, plan usage, feature allowances, and accessible project limits with the REST API.

Start with account context

Call these endpoints before an automation that depends on plan access or available capacity. The response identifies the authenticated account and exposes the current feature allowances, usage, and accessible project limit. See authentication for the required bearer key.

Do not treat plan or allowance data as permanent configuration. Read it again when a workflow starts a crawl or needs to decide whether an optional feature is available, then use projects to select the correct project. See errors and limits before implementing retries or pagination.

Get the authenticated account context

GET /account

Returns the current plan, feature availability, and accessible project count.

Authorization

bearerApiKey

Authorization: Bearer

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Response Body

200 application/json

401 application/json

403 application/json

429 application/json

cURL

curl -X GET "https://api.screpy.com/v1/account"

Response Examples

200

{
  "data": {
    "plan": "string",
    "is_paid": true,
    "project_count": 0,
    "features": {
      "property1": true,
      "property2": true
    }
  }
}

401

{
  "message": "Unauthenticated."
}

403

{
  "message": "string",
  "code": "string"
}

429

{
  "message": "string",
  "code": "string"
}

Get account usage and feature allowances

GET /account/usage

Authorization

bearerApiKey

Authorization: Bearer

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Response Body

200 application/json

401 application/json

403 application/json

429 application/json

cURL

curl -X GET "https://api.screpy.com/v1/account/usage"

Response Examples

200

{
  "data": {
    "plan": "string",
    "features": {
      "property1": true,
      "property2": true
    },
    "limits": {
      "property1": {
        "limit": 0,
        "used": 0,
        "remaining": 0
      },
      "property2": {
        "limit": 0,
        "used": 0,
        "remaining": 0
      }
    }
  }
}

401

{
  "message": "Unauthenticated."
}

403

{
  "message": "string",
  "code": "string"
}

429

{
  "message": "string",
  "code": "string"
}