List Integrations

List Integrations

GET https://api.ocamba.com/v1/hood/integrations
Returns a list of Integrations

Tip

Sortable fields are: name, is_default, create_time and update_time.

Searchable fields is: name.

Filterable fields are: id, name, type, is_default, provider_id, status, effective_status, create_time and update_time.

Rate limits:

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

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/integrations" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/integrations';
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/integrations");
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": 2,
  "items": [
    {
      "id": "1009",
      "company_id": "3813298",
      "name": "Example 1",
      "type": "sms",
      "provider_id": "1000",
      "settings": {
        "account_sid": "AC85XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "auth_token": "bb3XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "default_phone_number": "+17817802434"
      },
      "status": "active",
      "is_default": false,
      "create_time": "2024-05-23 09:50:45",
      "update_time": "2024-05-23 09:55:37"
    },
    {
      "id": "1008",
      "company_id": "3813298",
      "name": "Example 2",
      "type": "sms",
      "provider_id": "1000",
      "settings": {
        "account_sid": "ACffc7XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "auth_token": "f9cfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "default_phone_number": "+13343397558"
      },
      "status": "active",
      "is_default": true,
      "create_time": "2024-05-23 09:50:27",
      "update_time": "2024-05-23 09:50:27"
    }
  ]
}

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