View Provider

GET /providers/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/providers/{id}

Retrieves the details of a Provider if a valid identifier was provided.

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ providers ]
An array of all created items.
Provider
Name
Description
company_idstring
A unique identifier of the Company the user is a member of, generated by the Ocamba platform.


Example: 1000000
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
idstring
A unique identifier of the Provider, generated by the Ocamba platform.


Example: 1000000
logostring
The provider logo. String of maximum 100 characters.


Example: https://example.com/logo.jpg
namestring
The name of the Provider.


Example: twilio
settings[ provider-settings ]
The settings of the provider required for the integration to be successful.
Settings
Name
Description
deprecatedboolean
Determines whether this parameter is deprecated.


Example: true
namestring
The name of the parameter, from 1 to 100 characters range.


Example: p_key
requiredboolean
Determines whether this parameter is mandatory.


Example: true
titlestring
The title of the parameter, from 1 to 100 characters range.


Example: Private key
typestring
The type of the parameter.


Example: integer

Possible values: string | integer | boolean
titlestring
The title of the Provider.


Example: Twilio SMS
typestring
The provider type.


Example: sms

Possible values: sms | email | telegram

Default: sms
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the provider id, list the providers to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "1000000",
      "company_id": "1000000",
      "title": "Twilio SMS",
      "name": "twilio",
      "type": "sms",
      "logo": "https://example.com/logo.jpg",
      "settings": [
        {
          "title": "Private key",
          "name": "p_key",
          "type": "integer",
          "required": true,
          "deprecated": true
        }
      ],
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}