Get Recipient - OneNumber Documentation

Get Recipient

curl --request GET \
  --url https://staging.api.onenumber.africa/v1/recipients/{reference} \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "reference": "<string>",
      "phoneNumber": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>"
    }
  ]
}

GET

recipients

{reference}

Get Recipient

curl --request GET \
  --url https://staging.api.onenumber.africa/v1/recipients/{reference} \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "reference": "<string>",
      "phoneNumber": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>"
    }
  ]
}

Request Path Parameter

reference

string

required

The reference of the Recipient.

Successful Response Data

data

array

Show properties

reference

string

The reference of the Recipient.

phoneNumber

string

The phone number of the Recipient.

firstName

string

The first name of the Recipient.

lastName

string

The last name of the Recipient.

string

The email of the Recipient.

Create a new Recipient Get all Recipients

Documentation Index

​Request Path Parameter

​Successful Response Data

Request Path Parameter

Successful Response Data