GET
/
rr
/
api
/
v1
/
contracts
List Contracts
curl --request GET \
  --url https://api.meetcampfire.com/rr/api/v1/contracts \
  --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,
      "entity_name": "<string>",
      "client_name": "<string>",
      "department_name": "<string>",
      "parent_department_name": "<string>",
      "parent_department": 123,
      "tags": "<string>",
      "total_revenue": 0,
      "total_mrr": 0,
      "total_billed": 0,
      "total_unbilled": 0,
      "total_paid": 0,
      "total_outstanding": 0,
      "total_deferred_revenue": 0,
      "currency": "USD",
      "entity_currency": "USD",
      "attachments": [
        {
          "id": 123,
          "customer": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": 123,
          "created_by_name": "<string>",
          "created_by_email": "<string>",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "url": "<string>",
          "s3_content_type": "<string>",
          "s3_content_length": 1073741823,
          "s3_path": "<string>",
          "object_id": 1073741823,
          "app": "<string>",
          "model": "<string>"
        }
      ],
      "contract_end_date": "2023-12-25",
      "search_vector": "<string>",
      "search_text": "<string>",
      "billing_frequency": "monthly",
      "deal_name": "<string>",
      "deal_id": "<string>",
      "consultant": "<string>",
      "closed_date": "2023-12-25",
      "total_contract_value": 0,
      "contract_start_date": "2023-12-25",
      "exchange_rate": 0,
      "exchange_rate_book": 0,
      "crm_link": "<string>",
      "contract_link": "<string>",
      "status": "ACTIVE",
      "source": "SALESFORCE",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "auto_renew": true,
      "auto_renew_duration": -1,
      "auto_renew_invoice": true,
      "customer": 123,
      "entity": 123,
      "client": 123,
      "department": 123,
      "journal_entries": [
        123
      ]
    }
  ]
}

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.