List User Recipients

GET

/users/{user_id}/recipients

Returns the recipients associated with the given user across all their inboxes.

Authorizations

Send your API key in the x-api-key header. See Authentication.

Parameters

Path Parameters

user_id

required

string

Query Parameters

page

integer

The desired page from the result set. Defaults to 1.

per_page

integer

The number of items per page. Defaults to 100.

Responses

200

Success

object

total

Total number of items across all pages.

integer

15

per_page

Number of items per page.

integer

100

current_page

The current page number (1-based).

integer

1

last_page

The last available page number.

integer

1

from

The index of the first item on this page (1-based).

integer

1

to

The index of the last item on this page (1-based).

integer

15

data

Array<object>

object

id

integer

1001

created_at

string format: date-time

updated_at

string format: date-time

name

string

Jane Doe

type

string

recipient

is_new_pmb

boolean

ecm_number

string

Example

{
  "current_page": 1,
  "data": [
    {
      "id": 1001,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "name": "Jane Doe",
      "type": "recipient"
    },
    {
      "id": 1002,
      "created_at": "2024-02-20T14:00:00Z",
      "updated_at": "2024-02-20T14:00:00Z",
      "name": "John Smith",
      "type": "recipient"
    }
  ],
  "from": 1,
  "to": 100,
  "last_page": 2,
  "per_page": 100,
  "total": 120
}

401

The x-api-key header is missing or the key is not valid, or the caller can’t access an ID in the request. IDs that don’t exist return the same response as IDs the caller can’t access.

Error envelope returned with 4xx and 5xx responses.

object

error

object

code

Usually the HTTP status code. It can differ; a request to an unknown path returns HTTP 400 with code 500.

integer

401

message

Human-readable description of the error.

string

type

The kind of error, for example Authorization or REST.

string

REST

fields

Returned only with 422 responses. It may give more details about what failed validation, as lists of messages keyed by the name of the input.

object

key

additional properties

Array<string>

Examples

{
  "error": {
    "code": 401,
    "message": "The request does not include a valid access token. Please provide a valid access token.",
    "type": "Authorization"
  }
}

{
  "error": {
    "code": 401,
    "message": "x-api-key: x-api-key is invalid",
    "type": "REST"
  }
}

{
  "error": {
    "code": 401,
    "message": "User does not have access to requested resource.",
    "type": "Authorization"
  }
}