User Guides Developer Guides API Reference Changelog

List Partners

List Partners

GET https://api.ocamba.com/v1/hood/partners
Returns a list of Partners

Tip

Sortable fields are: name, create_time and update_time.

Searchable field is: name.

Filterable fields are: id, managers, type, status, payment_frequency, payment_method, net_terms, currency, archived, create_time and update_time.

If you want to find all your archived partners, you should use the filter ‘archived’.

Rate limits:

  • Burst: 10/s
  • Steady: 150/m

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/partners" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/partners';
const options = {
  method: 'GET',
  headers: {
    Authorization: `Bearer {TOKEN}`
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
$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

{
  "total": 3,
  "items": [
    {
      "id": "1000418",
      "company_id": "6197120",
      "manager_ids": [
        "1000188"
      ],
      "managers": [
        {
          "id": "1000188",
          "name": "Noah Turner",
          "email": "[email protected]",
          "status": "active"
        }
      ],
      "name": "Test Partner",
      "type": [
        "advertiser",
        "publisher"
      ],
      "status": "inactive",
      "system": 0,
      "create_time": "2024-09-24 13:28:19",
      "update_time": "2024-09-24 13:29:21"
    },
    {
      "id": "1000417",
      "company_id": "6197120",
      "manager_ids": [
        "1000189",
        "1000220"
      ],
      "managers": [
        {
          "id": "1000189",
          "name": "John Doe",
          "email": "[email protected]",
          "status": "active",
          "image": "https://sm.ocmcore.com/share/6197120/adex/media/1120152205rain-forest-36703721.jpg"
        },
        {
          "id": "1000220",
          "name": "Alex Claire",
          "email": "[email protected]",
          "status": "active"
        }
      ],
      "name": "Partner Example",
      "type": [
        "publisher"
      ],
      "status": "active",
      "system": 0,
      "create_time": "2024-09-24 11:26:04",
      "update_time": "2024-09-24 11:26:04"
    },
    {
      "id": "1000416",
      "company_id": "6197120",
      "manager_ids": [
        "1000189",
        "1000220"
      ],
      "managers": [
        {
          "id": "1000189",
          "name": "John Doe",
          "email": "[email protected]",
          "status": "active",
          "image": "https://sm.ocmcore.com/share/6197120/adex/media/1120152205rain-forest-36703721.jpg"
        },
        {
          "id": "1000220",
          "name": "Alex Claire",
          "email": "[email protected]",
          "status": "active"
        }
      ],
      "name": "Another Partners Example",
      "type": [
        "advertiser"
      ],
      "status": "active",
      "system": 0,
      "create_time": "2024-09-24 11:25:19",
      "update_time": "2024-09-24 11:25:19"
    }
  ]
}

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

500 Internal Server Error

{
  "code": 500,
  "title": "Internal server error.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
Responses
LinkedIn Facebook Instagram