List Members

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

Members function returns details of the selected members

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
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.
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.

statusstring
Represents member's current status. May be Active, Pending, Expired.


Example: status="expired"
emailstring
Member's email address.


Example: status="expired"
idinteger
Unique member's id.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ member ]
An array of all created items.
Member
Name
Description
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000000
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
emailstring (email)
Member email address.


Example: [email protected]
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 member.


Example: John Doe
preferencesobject

Name
Description
generalgeneral-setting
General settings object.
General Settings
Name
Description
currencystring
Currency which will be applied to all Ocamba platform transactions.


Example: EUR
date_formatstring
Date format which will be applied to the overall Ocamba UI.


Example: DD-MM-YYYY
first_week_daystring
First day of week which will be applied to the overall Ocamba UI.


Example: mon
number_formatobject

Name
Description
decimal_separatorstring
Separator represented as comma.


Example: ,
thousand_separatorstring
Separator represented as dot.


Example: .
themestring
Theme which will be applied to the overall Ocamba UI.


Example: light
time_formatstring
Time format which will be applied to the overall Ocamba UI.


Example: 24
timezoneinteger
Time zone which will be applied to the overall Ocamba UI.


Example: 1
securitysecurity-setting
Security settings object.
Security Settings
Name
Description
country_restrictions[ string ]
Array of countries allowed to access to the Ocamba platform.
ip_restrictions[ string ]
Array of unique IP addresses allowed to access to the Ocamba platform. Only IPv4 format is supported.
statusstring
Describe member status.


Example: active

Possible values: active | suspended

Default: active
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
totalinteger
A total number of items.


Example: 29
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 29,
  "items": [
    {
      "id": "1000163",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "create_time": "2021-07-30T12:50:13Z",
      "update_time": "2021-07-30T12:50:13Z"
    },
    {
      "id": "1000006",
      "name": "Jane Doe",
      "status": "active",
      "email": "[email protected]",
      "create_time": "2020-08-28T11:29:48Z",
      "update_time": "2021-04-15T17:13:59Z"
    },
    {
      "id": "1000005",
      "name": "Johnny Doe",
      "status": "active",
      "email": "[email protected]",
      "image": "https://storage.ocamba.com/6197120/members/1000005/image/jonny.png"
    }
  ]
}

{
  "total": 29,
  "items": [
    {
      "id": "1000163",
      "company_id": "1000000",
      "name": "John Doe",
      "status": "active",
      "email": "[email protected]",
      "image": "https://image-uri-example.com",
      "preferences": {
        "general": {
          "theme": "light",
          "timezone": 1,
          "number_format": {
            "thousand_separator": ".",
            "decimal_separator": ","
          },
          "date_format": "DD-MM-YYYY",
          "time_format": "24",
          "first_week_day": "mon",
          "currency": "EUR"
        },
        "security": {
          "ip_restrictions": [
            [
              "1.1.1.1"
            ]
          ],
          "country_restrictions": [
            [
              "AF"
            ]
          ]
        }
      },
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}