GET
/
v1
/
worksites
curl --request GET \
  --url https://api.opx.co/partners/v1/worksites
{
  "data": [
    {
      "id": 123,
      "reference": "<string>",
      "external_reference": "<string>",
      "convention_id": 123,
      "beneficiary_id": 123,
      "installer_name": "<string>",
      "zipcode": "<string>",
      "address": "<string>",
      "city": "<string>",
      "status": "<string>",
      "created_at": "<string>",
      "precarity_type": "<string>",
      "fiscal_informations": [
        {
          "firstname": "<string>",
          "lastname": "<string>",
          "fiscal_number": "<string>",
          "fiscal_reference": "<string>"
        }
      ],
      "indivision": true
    }
  ]
}

Query Parameters

page
integer | null
Required range: x >= 1
per_page
integer | null
Required range: 1 <= x <= 100

Response

200
application/json
`WorksiteCollection`
data
object[]
required