GET
/
v1
/
beneficiaries
Beneficiaries list
curl --request GET \
  --url https://api.opx.co/partners/v1/beneficiaries
{
  "data": [
    {
      "id": 123,
      "firstname": "<string>",
      "lastname": "<string>",
      "company_name": "<string>",
      "siren": "<string>",
      "siret": "<string>",
      "address": "<string>",
      "city": "<string>",
      "zipcode": "<string>",
      "country": "<string>",
      "mobile_phone": "<string>",
      "phone": "<string>",
      "email": "<string>"
    }
  ]
}

Query Parameters

​
page
integer | null
Required range: x >= 1
​
per_page
integer | null
Required range: 1 <= x <= 100
​
type
enum<string> | null
Available options:
b2c,
b2b
​
convention_id
integer | null
​
keyword
string | null

nécessaire lorque le chantier est crée par un mandataire

Response

200
application/json

BeneficiaryCollection

The response is of type object.