List Blocked Contacts

GET /blocked-contacts
Copied
Arrow
                https://api.ocamba.com/v1/hood/blocked-contacts

Returns a list of Blocked Contacts

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
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.


Example: sort=-field1,field2
pagestring
The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.


Example: page=1,10
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/hood/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.
read_gdpr_fieldsstring
Describes if the PI data located on the object are going to be displayed as hidden, or real values.


Example: read_gdpr_fields=true
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ blocked-contact ]
An array of all created items.
Blocked Contact
Name
Description
company_idstring
A unique company identifier generated by the Ocamba.


Example: 7196310
contactstring
An actual actionable that can not be contacted.


Example: +1234567890
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
creatorcreator
A unique identifier for the creator, generated by Ocamba, who is also a Ocamba member.
Creator
Name
Description
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000000
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000163
imagestring (url)
The image of the member.


Example: https://image-uri-example.com
namestring
Name of the Ocamba member.


Example: John Doe
statusstring
Describe Ocamba member status.


Example: active

Possible values: active | suspended

Default: active
creator_idstring
A unique member identifier generated by the Ocamba.


Example: 1000163
descriptionstring
A reason for adding this contact to the Blocked Contact list.


Example: Description example.
idstring
A unique identifier generated by the Ocamba.


Example: 450
typestring
Type of actionable that can not be contacted.


Example: mobile_phone_number

Possible values: mobile_phone_number | email
update_timestring
Timezone: GMT.


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


Example: 5
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
tip
1 Searchable field is: description.
2 Sortable fields are: create_time and update_time.
3 Filterable fields are: id, creator_id, type, create_time, update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 500
{
  "total": 5,
  "items": [
    {
      "id": "450",
      "company_id": "7196310",
      "creator_id": "1000163",
      "creator": {
        "id": "1000163",
        "company_id": "1000000",
        "name": "John Doe",
        "status": "active",
        "image": "https://image-uri-example.com"
      },
      "contact": "+1234567890",
      "type": "mobile_phone_number",
      "description": "Description example.",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}