Contracts / List

GET

api

crm

contracts

Contracts / List

curl --request GET \
  --url https://api.chargecloud.dev/api/v1/crm/contracts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.chargecloud.dev/api/v1/crm/contracts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chargecloud.dev/api/v1/crm/contracts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chargecloud.dev/api/v1/crm/contracts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chargecloud.dev/api/v1/crm/contracts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "contracts": [
    {
      "id": 123,
      "uuid": "<string>",
      "type": "energy",
      "energy": "electricity",
      "business": false,
      "firstname": "<string>",
      "surname": "<string>",
      "blocked": false,
      "disabled": false,
      "usage": 123,
      "zip": "<string>",
      "city": "<string>",
      "customer_number": "<string>",
      "company_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "cancelled_at": "2023-11-07T05:31:56Z",
      "status": "open"
    }
  ],
  "pagination": {
    "page": "1",
    "total_pages": "5",
    "page_size": "10",
    "has_more": "true"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "errors": [
    {
      "errorKey": "<string>",
      "message": "<string>",
      "parameter": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

OAuth2 Bearer Authorization

Scopes

crm:contracts

Headers

Accept-Language

string

BCP 47 language tag for content negotiation (e.g. en, de-DE).

Example:

"en"

Query Parameters

customerNumber

string

Customer-number filter; partial, case-insensitive match.

name

string

Partial, case-insensitive match against the contract holder's firstname, surname, or company name.

extContractId

string

Filters by the upstream-system contract identifier (EDI feed, partner integration, migration import).

status

enum<string>

Filters by contract lifecycle status; omit to return any status. Allowed values: open (created, not yet started); cancellation_previous (cancellation sent to previous provider, energy only); delivery_net (registered with distribution network operator, energy only); waiting (approved, awaiting delivery start); active (delivery in progress); blocked (frozen, no state changes); terminated (cancelled, end date set); expired (end date passed); cancelled (annulled before becoming active); done (completed). Not every value applies to every contract type.

Available options:

open,

cancellation_previous,

delivery_net,

waiting,

active,

blocked,

terminated,

expired,

done,

cancelled

limit

integer<int64>

Maximum number of items per page. Maximum value is 25.

Required range: 1 <= x <= 25

Example:

"10"

page

integer<int64>

Page number to retrieve (starting from 1).

Required range: x >= 1

Example:

"1"

Response

Paginated page of contracts in list-mode projection.

contracts

object[]

required

Contracts on this page; empty array when no contracts match the filters.

Show child attributes

pagination

object

Pagination

Show child attributes

⌘I

Contracts / List

curl --request GET \
  --url https://api.chargecloud.dev/api/v1/crm/contracts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.chargecloud.dev/api/v1/crm/contracts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.chargecloud.dev/api/v1/crm/contracts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.chargecloud.dev/api/v1/crm/contracts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.chargecloud.dev/api/v1/crm/contracts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "contracts": [
    {
      "id": 123,
      "uuid": "<string>",
      "type": "energy",
      "energy": "electricity",
      "business": false,
      "firstname": "<string>",
      "surname": "<string>",
      "blocked": false,
      "disabled": false,
      "usage": 123,
      "zip": "<string>",
      "city": "<string>",
      "customer_number": "<string>",
      "company_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "cancelled_at": "2023-11-07T05:31:56Z",
      "status": "open"
    }
  ],
  "pagination": {
    "page": "1",
    "total_pages": "5",
    "page_size": "10",
    "has_more": "true"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "errors": [
    {
      "errorKey": "<string>",
      "message": "<string>",
      "parameter": "<string>"
    }
  ]
}

Getting started - Core

Core API

Authorizations

Scopes

Headers

Query Parameters

Response