GET
/
rr
/
api
/
v1
/
customers
List Contract Customers
curl --request GET \
  --url https://api.meetcampfire.com/rr/api/v1/customers \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 123,
      "customer": 123,
      "name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "phone_number": "<string>",
      "mobile_number": "<string>",
      "currency": "<string>",
      "total_contracts": 123,
      "active_contracts": 123,
      "completed_contracts": 123,
      "pending_contracts": 123,
      "total_revenue": 0,
      "total_mrr": 0,
      "total_billed": 0,
      "total_unbilled": 0,
      "total_paid": 0,
      "total_outstanding": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "contacts": [
        {
          "id": 123,
          "name": "<string>",
          "first_name": "<string>",
          "last_name": "<string>",
          "email": "jsmith@example.com",
          "phone_number": "<string>",
          "mobile_number": "<string>"
        }
      ],
      "total_deferred_revenue": 0
    }
  ]
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Response

200 - application/json

The response is of type object.