GET
/
v1
/
companies
/
{company_id}
/
accounts
curl --request GET \
  --url https://api.gofermata.com/v1/companies/{company_id}/accounts/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "email": "string",
      "company_id": "string",
      "plan_id": "string",
      "plan_renewal_cadence": "string",
      "stripe_id": "string",
      "created_at": "string",
      "updated_at": "string",
      "metadata": {},
      "last_plan_renewal": "2019-08-24T14:15:22Z",
      "next_plan_renewal": "2019-08-24T14:15:22Z",
      "plan_status": "string",
      "flags": [
        {}
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

To authenticate against the API, use HTTP Basic Authentication with your customer ID as the username and API key as the password.

Path Parameters

company_id
string
required

Query Parameters

email
string

Search for accounts with given email address

id
string

Search for accounts by ID

Response

200 - application/json
data
object[]

Accounts are the customers of Companies. They are what are actually generating events and being billed