List Providers

List Providers

GET https://api.ocamba.com/v1/hood/providers
Returns a list of Providers

Rate limits:

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

Query parameters

parameters

Response schemas

curl -X GET \
 "https://api.ocamba.com/v1/hood/providers" \
  -H "Authorization: Bearer {TOKEN}"
const url = 'https://api.ocamba.com/v1/hood/providers';
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/providers");
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": "1000",
      "type": "sms",
      "name": "twilio",
      "title": "Twilio SMS"
      "logo": "https://sm.ocmcore.com/share/4555599/ocamba/apps/hood/integrations/providers/twilio_logo.png",
      "settings": [
        {
          "title": "Account SID",
          "name": "account_sid",
          "type": "string",
          "required": true,
          "deprecated": false
        },
        {
          "title": "Auth Token",
          "name": "auth_token",
          "type": "string",
          "required": true,
          "deprecated": false
        },
        {
          "title": "Default Phone Number",
          "name": "default_phone_number",
          "type": "string",
          "required": true,
          "deprecated": false
        }
      ],
      "create_time": "2024-05-13 10:53:13",
      "update_time": "2024-05-16 11:52:01"
    }
  ]
}

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

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

Searchable fields are: name and logo.

Filterable fields are: id, name and type.