Get Integration

GET https://api.ocamba.com/v1/hood/integrations/{id}

Retrieves the details of an Integration if a valid identifier was provided.

Tip

If you’re trying to see integrations by type, please apply the type filter, adding ‘sms’ or ’email’ as a value, according to your needs.

If you don’t know the provider id, list the integrations to find it.

Warining

Pay attention to the Provider Settings array. The settings in the Integration should have the fields described by the Provider Settings.

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Query parameters

parameters

Response schemas

›

200

application/json

›

400

application/json

›

500

application/json

curl -X GET \
 "https://api.ocamba.com/v1/hood/integrations/{id}" \
  -H "Authorization: Bearer {TOKEN}"

const url = 'https://api.ocamba.com/v1/hood/integrations/{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/integrations/{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

{
  "id": "1161",
  "company_id": "6197120",
  "name": "Example Integration",
  "type": "sms",
  "provider_id": "1000",
  "provider": {
    "id": "1000",
    "type": "sms",
    "name": "twilio",
    "logo": "https://sm.ocmcore.com/share/4555599/ocamba/apps/hood/integrations/providers/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"
  },
  "settings": {
    "account_sid": "ACfXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "auth_token": "f9cXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "default_phone_number": "+1334XXXXXXXX"
  },
  "status": "active",
  "is_default": false,
  "create_time": "2024-05-23 06:33:01",
  "update_time": "2024-05-23 06:33:01"
}

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