View Limit Recipient

GET /limit-recipients/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/limit-recipients/{id}

Retrieves the details of a Limit Recipient.

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
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
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000000
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
idstring
Recipient email.


Example: [email protected]
namestring
Name of the member.


Example: John Doe
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
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.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 500
{
  "id": "[email protected]",
  "company_id": "1000000",
  "name": "John Doe",
  "create_time": "2021-07-30 12:50:13",
  "update_time": "2021-07-30 12:50:13"
}

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