View Partner

View Partner

GET https://api.ocamba.com/v1/hood/partners/{id}
Retrieves the details of a Partner if a valid identifier was provided.

Rate limits:

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

Path parameters

parameters

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/partners/{id}" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/partners/{id}';
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/{id}");
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": 1,
  "items": [
    {
      id": "1000412",
      "company_id": "6197120",
      "manager_ids": [
        "1000220"
      ],
      "managers": [
        {
          "id": "1000220",
          "name": "Isabella Reed",
          "email": "[email protected]",
          "status": "active"
        }
      ],
      "name": "Hairdressing Claire",
      "description": "This is a publisher on a hairdressing website",
      "type": [
        "publisher"
      ],
      "status": "inactive",
      "payment_terms": {
        "payment_frequency": "quarterly",
        "payment_method": "card",
        "net_terms": "net90",
        "currency_code": "eur"
      },
      "billing_address": {
        "street": "Victoria Park Ave",
        "city": "Toronto",
        "post_code": "M4B 2J8",
        "country": "CA"
      },
      "contact": {
        "email": "[email protected]",
        "mobile": "+785596522",
        "phone": "+1235165336",
        "sip": "5259oskZYi9sw8",
        "skype": "dfa223ghjk",
        "website": "hairdresser-saloon.com"
      },
      "system": 0,
      "create_time": "2024-09-19 10:40:36",
      "update_time": "2024-09-19 10:40:36"
    }
  ]
}

400 Bad Request

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body 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

Tip
If you don’t know the partner id, list the partners to find it.
Note
If you want to read a specific archived partner, you should also use the ‘archived’ filter.