List Accounts

GET /accounts
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/accounts

Returns a list of Accounts

query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /v2/ocamba/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Ocamba 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
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
sortstring
Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

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

See tips for the list of sortable fields.


Example: sort=-field1,filed2
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 /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members 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 /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.
idinteger
Unique account id.
statusstring
Displays current status of the account
namestring
Name of the account.
update_timestring
Timezone: GMT.


Example: update_time=2021-09-14
create_timestring
Timezone: GMT.


Example: create_time=2021-09-14
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ account ]
An array of all created items.
Account
Name
Description
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000001
configured_statusstring
The configured_status reflects the current status of the account configured by the client.


Example: active

Possible values: active | verification | rejected paused | inactive | archived
contacts[ account-contact ]
List of account contacts.
Account Contact
Name
Description
idstring (uuid)
A unique identifier generated by the Ocamba platform.


Example: 95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b
typestring
Describes type of the contact.


Example: email

Possible values: phone | mobile | skype | sip | email | website
valuestring
The actual contact, based on contact type. For example, if contact type is email, the value must be a valid email address.


Example: [email protected]
create_timedateTime
Timezone: GMT.


Example: 2021-10-29 12:47:00
creator_idstring
A unique creator identifier generated by the Ocamba platform.


Example: 1000001
feedsobject
Values that are pasted to the creative landing URL.
Name
Description
postbacksstring



Example: https://google.com
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000000
imagestring (uri)
URL to the account image.


Example: https://storage.ocamba.com/1000001/adex/accounts/1000000/account.jpeg
is_defaultinteger
For default account is_default is set to 1. Default account can't be removed.


Example: 1

Possible values: 0 | 1
namestring
Name of the account.


Example: Demo account
statusstring
The status reflects the current status of the account which may be overridden by some background processes.


Example: active

Possible values: active | verification | rejected paused | inactive | archived | hourly-limit | daily-limit | monthly-limit | lifetime-limit

Default: active
update_timedateTime
Timezone: GMT.


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


Example: 3
tip
1 Searchable field is name.
2 Sortable fields are: creator_id, status, name, is_default, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 3,
  "items": [
    {
      "id": "1000000",
      "company_id": "1000001",
      "creator_id": "1000001",
      "status": "active",
      "configured_status": "active",
      "name": "Demo account",
      "image": "https://storage.ocamba.com/1000001/adex/accounts/1000000/account.jpeg",
      "contacts": [
        {
          "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
          "type": "email",
          "value": "[email protected]"
        }
      ],
      "feeds": {
        "postbacks": "https://google.com"
      },
      "is_default": 1,
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}