Account

The account: name, vocabulary, lexicon and settings#

GET /v1/account

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Change the account name, vocabulary, lexicon, settings or recording policy (owner only)#

PATCH /v1/account

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PATCH "$ANSWERSTACK_API_URL/v1/account" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "dismissSuggestions": [
    {
      "concept": "string",
      "phrase": "string"
    }
  ],
  "lexicon": [
    {
      "concept": "string"
    }
  ],
  "name": "string",
  "recordingPolicy": "always",
  "settings": {
    "loginSecurity": {
      "appliesTo": "everyone",
      "enabled": false,
      "methods": [
        "passkey",
        "totp",
        "sms",
        "email"
      ]
    },
    "notetaker": {
      "enabled": true,
      "lockedOn": false
    },
    "pricing": {
      "allowLocationServices": true,
      "priceApproval": "off",
      "priceApprovalIncludesCrm": false,
      "priceReviewDays": 90
    },
    "spendAlerts": {
      "monthlyBudgetCents": 100
    }
  },
  "vocabulary": {
    "contact": "string",
    "contactPlural": "string",
    "group": "string",
    "groupPlural": "string",
    "meeting": "string",
    "meetingPlural": "string",
    "service": "string",
    "servicePlural": "string",
    "special": "string",
    "specialPlural": "string"
  }
}'

Every API token in the account, whose it is, and when it was last used#

GET /v1/account/api-tokens

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/api-tokens" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Revoke any token in the account. It stops working at once#

DELETE /v1/account/api-tokens/{tokenId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/api-tokens/{tokenId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Cancel (owner only): the plan runs to the end of the billing period; a trial ends at once#

POST /v1/account/billing/cancel

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/billing/cancel" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "too_expensive"
}'

Keep a plan that was set to end (owner only)#

DELETE /v1/account/billing/cancel

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/billing/cancel" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Put a card on file: a Stripe Checkout page in setup mode (owner only)#

POST /v1/account/billing/card

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/billing/card" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Use a promo code on this account (owner only)#

POST /v1/account/billing/coupon

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/billing/coupon" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string"
}'

The promo codes this account has used, and what each gave#

GET /v1/account/billing/coupons

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/billing/coupons" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

What the account’s plan includes and costs: its own prices, number limit and allowances#

GET /v1/account/billing/plan

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/billing/plan" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Change plan (owner only): at once in a trial or for a higher fee, otherwise from the next billing period#

POST /v1/account/billing/plan

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/billing/plan" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "planId": "plan_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
}'

Ask our team to move a sales-led account to another plan (owner only); nothing changes until they do#

POST /v1/account/billing/plan-request

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 202

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/billing/plan-request" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "planId": "plan_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
}'

The plans a self-serve account can choose, with their prices#

GET /v1/account/billing/plans

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/billing/plans" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Change the card on file in Stripe's billing portal (owner only)#

POST /v1/account/billing/portal

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/billing/portal" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

The plan, the trial and its days left, and the trial allowances used#

GET /v1/account/billing/subscription

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/billing/subscription" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Pause anyone's booking page. The rep is told and cannot resume it themselves#

POST /v1/account/booking-pages/{pageId}/pause

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 402, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/booking-pages/{pageId}/pause" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Resume anyone's booking page. The rep is told#

POST /v1/account/booking-pages/{pageId}/resume

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 402, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/booking-pages/{pageId}/resume" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

The features this account has, and where each came from#

GET /v1/account/entitlements

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token). Bearer token: Authorization: Bearer <token> (An API token (ans_pat_ or ans_svc_). Only routes that list a scope here accept one, and only with that scope.).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/entitlements" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

The account's rules for connected apps#

GET /v1/account/mcp-policy

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/mcp-policy" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Whether members may connect apps, who may give write access, and which apps (owners and admins). Takes effect within a minute, without revoking anything#

PUT /v1/account/mcp-policy

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/mcp-policy" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "writeRoles": [
    "owner"
  ],
  "clientAllowlist": [
    "string"
  ]
}'

Team members#

GET /v1/account/members

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/members" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Invite a team member by email (owner only)#

POST /v1/account/members

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/members" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "[email protected]",
  "role": "owner"
}'

Change a member role or group scope (owner only)#

PATCH /v1/account/members/{memberId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PATCH "$ANSWERSTACK_API_URL/v1/account/members/{memberId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "groupIds": [
    "grp_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
  ],
  "role": "owner"
}'

Deactivate a member: their login is blocked at once (owner only)#

POST /v1/account/members/{memberId}/deactivate

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/members/{memberId}/deactivate" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Give a deactivated member their access back (owner only)#

POST /v1/account/members/{memberId}/reactivate

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/members/{memberId}/reactivate" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Send the invite email again (owner only)#

POST /v1/account/members/{memberId}/resend-invite

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/members/{memberId}/resend-invite" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Every app connected to the account, and who connected it#

GET /v1/account/oauth-grants

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/oauth-grants" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Take access away from any app connected to the account#

DELETE /v1/account/oauth-grants/{grantId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/oauth-grants/{grantId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

A member's booking pages, to pause or resume them#

GET /v1/account/reps/{userId}/booking-pages

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 402, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/reps/{userId}/booking-pages" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

The sample community and playbook, whether they are hidden, and what blocks hiding#

GET /v1/account/sample-data

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/sample-data" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Hide or show the sample data (owner only). Nothing is deleted#

PUT /v1/account/sample-data

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PUT "$ANSWERSTACK_API_URL/v1/account/sample-data" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "hidden": true
}'

Keep a sample community or playbook as an ordinary record. Keeping a community keeps the sample playbook it runs#

POST /v1/account/sample-data/keep

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/sample-data/keep" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "group",
  "id": "grp_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE"
}'

Software the account lets in, each with a role ceiling#

GET /v1/account/service-identities

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/service-identities" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Make a service identity for software, with a role ceiling no higher than your own and an optional group limit#

POST /v1/account/service-identities

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/service-identities" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "roleCeiling": "owner"
}'

Rename a service identity, or disable it: its tokens stop working until it is enabled again#

PATCH /v1/account/service-identities/{identityId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X PATCH "$ANSWERSTACK_API_URL/v1/account/service-identities/{identityId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "disabled": true,
  "name": "string"
}'

A service identity's OAuth clients, for partners that expect client_credentials#

GET /v1/account/service-identities/{identityId}/oauth-clients

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/service-identities/{identityId}/oauth-clients" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Give a service identity an OAuth client that signs in with client_credentials at our authorization server. The secret is shown once#

POST /v1/account/service-identities/{identityId}/oauth-clients

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/service-identities/{identityId}/oauth-clients" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "scopes": [
    "string"
  ]
}'

Revoke a service identity’s OAuth client. Its access tokens stop working at once#

DELETE /v1/account/service-identities/{identityId}/oauth-clients/{clientId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X DELETE "$ANSWERSTACK_API_URL/v1/account/service-identities/{identityId}/oauth-clients/{clientId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Give a service identity a token, within its role ceiling. 365 days unless you choose; only an owner may choose no expiry#

POST /v1/account/service-identities/{identityId}/tokens

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Request body

application/json, required.

Response 201