Account · Couplr Developers

Base URL: https://couplrfsm.com/api/v1. Conventions shared by every endpoint (examples, ids, dates, money) are on the API reference page. Errors, pagination and idempotency are in Errors, limits and retries.

Identify the API key#

GET /api/v1/me · any valid key

Works with any valid key. Use it to test a connection.

Example request

curl "https://couplrfsm.com/api/v1/me" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response (200)

{
    "company": "Summit Heat and Air",
    "key_name": "Zapier",
    "abilities": [
        "customers:read",
        "customers:write"
    ],
    "test_mode": false
}

Errors

Status	When
`401`	No key (`api_key_missing`), the key is unknown or revoked (`api_key_invalid`), the key had an end date that has passed (`api_key_expired`), or the key belongs to a private trial sandbox whose access window has ended (`sandbox_expired`).
`403`	The key lacks the ability this endpoint needs (`ability_missing`), no admin user is left to act for the key (`no_acting_admin`), or the company's account is not yet verified.
`429`	Too many requests (`rate_limited`). Wait `Retry-After` seconds.