List Invites

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

Returns a list of Invites

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 id of the invite.


Example: id=423
statusstring
Returns the status of the invite. May be Active, Pending, Expired


Example: status="expired"
create_timestring
Time of the invite, in Etc/GMT timezone.


Example: create_time = "2021-10-29 06:57:35"
inviter_idstring
A unique id of the inviter.


Example: inviter_id=123412
inviteestring
Email address of the User invited to Ocamba platform.


Example: [email protected]
invite_timestring
Inviting time, initial or subsequent, in Etc/GMT timezone.


Example: invite_time=2021-09-14
messagestring
Optional message sent to user invited to Ocamba.


Example: Hello, join Ocamba!
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ invite ]
An array of all created items.
Invite
Name
Description
accessobject
Key value pair of app_id(key) and role_id(value).


Example: { "1010": "1107" }
company_idstring
A unique identifier generated by the Ocamba platform.


Example: 1000163
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
idstring
A unique identifier generated by the Ocamba platform.


Example: 423
invite_timedateTime
Inviting time, Timezone: GMT.


Example: 2021-07-30 12:50:13
inviteestring
Email address of the person invited to Ocamba platform.


Example: [email protected]
inviter_idstring
A unique inviter identifier generated by the Ocamba platform.


Example: 1123163
messagestring
Optional message sent to user invited to Ocamba.


Example: some message
namestring
Name of the person invited to Ocamba platform.


Example: John Doe
statusstring
Describes invitation status.


Example: expired
update_timedateTime
Timezone: GMT.


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


Example: 11
tip
1 Searchable fields are: invitee, name and message.
2 Sortable fields are: id, inviter_id, invitee, name, status, create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
    "total": 11,
    "items": [
        {
          "id": "293",
          "inviter_id": "1000125",
          "invitee": "[email protected]",
          "name": "John Doe",
          "status": "expired",
          "create_time": "2021-10-29 06:59:40"
        },
        {
          "id": "292",
          "inviter_id": "1000005",
          "invitee": "[email protected]",
          "name": "John Doe",
          "status": "expired",
          "create_time": "2021-10-29 06:57:35"
        },
        {
          "id": "291",
          "inviter_id": "1000034",
          "invitee": "[email protected]",
          "name": "John Doe",
          "status": "expired",
          "create_time": "2021-10-20 15:09:38"
        }
    ]
}

{
  "total": 11,
  "items": [
    {
      "id": "423",
      "company_id": "1000163",
      "inviter_id": "1123163",
      "access": "{\n  \"1010\": \"1107\"\n}",
      "name": "John Doe",
      "invitee": "[email protected]",
      "message": "some message",
      "status": "expired",
      "invite_time": "2021-07-30 12:50:13",
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}