View Invite

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

Retrieves the details of an Invite if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique id of the invite.


Example: id=423
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

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: 1
tip
1 If you don't know the invite id, list the invites to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
      {
        "id": "293",
        "inviter_id": "1000125",
        "invitee": "[email protected]",
        "name": "John Doe",
        "status": "expired",
        "create_time": "2021-10-29T06:59:40Z"
      }
  ]
}

{
  "total": 1,
  "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"
    }
  ]
}