List Partners

List Partners

GET https://api.ocamba.com/v1/hood/partners

Returns a list of Partners

Rate limits:

Burst: 10/s
Steady: 150/m

Query parameters

parameters

Response schemas

GET https://api.ocamba.com/v1/hood/partners HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/partners" \
  -H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/partners", {
  method: "GET",
  headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/partners");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $token"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Responses

200 OK

HTTP/1.1 200 OK
Content-Type: application/json

{
  "total": 32,
  "items": [
    {
      "id": "1000018",
      "company_id": "2136950",
      "manager_ids": "11153151,6643410,3183560",
      "managers": [
        {
          "id": "1000223",
          "name": "Alex Claire",
          "status": "active",
          "email": "[email protected]",
          "image": "https://sm.ocmcore.com/share/1231233/adex/media/profile-pic-36703721.jpg"
        }
      ],
      "name": "Example Partner Name",
      "description": "Example description.",
      "type": "advertiser",
      "status": "active",
      "payment_terms": {
        "payment_frequency": "annually",
        "payment_method": "card",
        "net_terms": "net30",
        "currency_code": "usd"
      },
      "billing_address": {
        "street": "108 Hanson St",
        "city": "Toronto",
        "postal_code": "M4C 1A1",
        "country": "ca"
      },
      "contact": {
        "email": "[email protected]",
        "mobile": "+15551234567",
        "phone": "+441632960961",
        "sip": "[email protected]",
        "skype": "john.doe123",
        "website": "https://www.example.com"
      },
      "system": 1,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}
Responses

Tip
1
Sortable fields are: name, create_time and update_time.
2
Searchable field is: name.
3
Filterable fields are: id, managers, type, status, payment_frequency, payment_method, net_terms, currency, archived, create_time and update_time.
4
If you want to find all your archived partners, you should use the filter ‘archived’.