Skip to main content
GET
/
admin
/
contracts
Get contracts
curl --request GET \
  --url https://api-dev.narrative.io/admin/contracts \
  --header 'Authorization: Bearer <token>'
{
  "records": [
    {
      "contract": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "payable_company_id": 123,
        "payment_method": {
          "type": "credit_card"
        },
        "revision": 123,
        "revision_start": "2023-11-07T05:31:56Z",
        "updated_by": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "internal_notes": "<string>",
        "revision_notes": "<string>",
        "revision_end": "2023-11-07T05:31:56Z"
      },
      "rates": [
        {
          "rate": {
            "type": "per_unit",
            "unit_price": {
              "value": 123,
              "expressed_in": "cents",
              "currency": "USD"
            }
          },
          "product": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sku": "<string>",
            "sku_type": {
              "category": "processing"
            },
            "payable_company_id": 123,
            "name": "<string>",
            "unit": "<string>",
            "status": "active"
          },
          "start_at": "2023-11-07T05:31:56Z",
          "end_at": "2023-11-07T05:31:56Z",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer

Number of records to return.

offset
integer

Number of records to skip (it's usually page_number * per_page).

Response

200 - application/json

OK

records
object[]