Allowances

Refresh Allowance

post

Refreshes the usage allowances for the company associated with the current API key.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/allowances/refresh

HTTPcURLJavaScriptPython

POST /api/v1/allowances/refresh HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}

Get Company Allowance

get

Retrieves the current allowance limits, usage, and remaining capacity for the company associated with the current API key.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Responses

200

Successful response

application/json

get

/api/v1/my/company/allowance

HTTPcURLJavaScriptPython

GET /api/v1/my/company/allowance HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "data": {
    "allowance": {},
    "usage": {},
    "remaining": {}
  }
}