List Limit Recipients

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

Returns a list of Limit Recipients

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
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.
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ limit-recipient ]
An array of all created items.
Limit Recipient
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
totalinteger
A total number of items.


Example: 3
400 - Bad Request
Arrow
Name
Description
codeinteger
Http response status code.


Example: 400
messagestring
The human readable message that describes how to deal with error.


Example: The request body is not valid.
titlestring
The error title.


Example: Bad request.
trace_idstring
Error trace id.


Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62
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.
tip
1 If you don't know the limit recipient id, list the limit recipients to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 400
  • 500
{
  "total": 3,
  "items": [
    {
      "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": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

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