{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OPX","colors":{"primary":"#1730BF","light":"#4F95FF","dark":"#1730BF"},"logo":{"light":"https://mintcdn.com/opx/OMvPuuHV3xFuPVay/logo/opx-dark.svg?fit=max\u0026auto=format\u0026n=OMvPuuHV3xFuPVay\u0026q=85\u0026s=399ae365414d8cf0abb91632d4cda098","dark":"https://mintcdn.com/opx/OMvPuuHV3xFuPVay/logo/opx-dark.svg?fit=max\u0026auto=format\u0026n=OMvPuuHV3xFuPVay\u0026q=85\u0026s=399ae365414d8cf0abb91632d4cda098"},"favicon":"https://mintcdn.com/opx/OMvPuuHV3xFuPVay/favicon.svg?fit=max\u0026auto=format\u0026n=OMvPuuHV3xFuPVay\u0026q=85\u0026s=3519a4f79e70542ffa636d07bc0e585d","navbar":{"links":[{"href":"mailto:contact@opx.co","label":"Support"}],"primary":{"type":"button","label":"Fonctionnalités","href":"https://www.opx.co/features"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/opx-co"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Features","icon":"globe","href":"https://www.opx.co/"},{"anchor":"Book a demo","icon":"hand-holding-heart","href":"https://www.opx.co/demo"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"opx","hasAudioNarration":false,"actualSubdomain":"opx","customDomains":["docs.opx.co"],"gitSource":{"type":"github","owner":"drapo-solutions","repo":"mintlify-doc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae818021795b614d9d55e98","collectionId":"ca037f98-fd71-41e5-b196-f01d968b268d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae818021795b614d9d55e98"},"entitlements":{},"buildId":"6ae818021795b614d9d55e98","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference (beta)","count":58},{"language":"default","tag":"Documentation","count":8},{"language":"default","tag":"WorksiteTags","count":8},{"language":"default","tag":"Beneficiaries","count":5},{"language":"default","tag":"Materials","count":5},{"language":"default","tag":"Subcontractors","count":5},{"language":"default","tag":"Worksites","count":5},{"language":"default","tag":"WorksitesDocuments","count":5},{"language":"default","tag":"WorksitesOperations","count":5},{"language":"default","tag":"Conventions","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"partners-api/beneficiaries/beneficiaries-list","slug":"/partners-api/beneficiaries/beneficiaries-list","pageMetadata":{"title":"Beneficiaries list","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/beneficiaries","href":"/partners-api/beneficiaries/beneficiaries-list","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Beneficiaries list","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/beneficiaries","href":"/partners-api/beneficiaries/beneficiaries-list","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"partners.beneficiaries.index","summary":"Beneficiaries list","tags":["Beneficiaries"],"parameters":["5bedbb0b-c335-4512-8fc9-315f8add34de","5932d730-4aa2-4af3-9512-fe1666fd200a","7f2e577e-4e60-47d8-90ef-e9e2257638f8","24077c1f-c8ab-4250-bdaa-b780a9046a6d","3186da01-383c-4ccd-8aed-cc208a71c404"],"responses":{"200":"7732f977-b19a-48f3-859e-09e75d905c54","422":"bcf0ab1e-05cf-44a2-a8be-13e1fa2b82dc"},"method":"get","type":"path","servers":["af0d8742-acac-4471-b4d8-94172cc34675"],"security":[],"path":"/v1/beneficiaries","baseUrlOptions":["https://api.opx.co/partners"],"title":"Beneficiaries list","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5bedbb0b-c335-4512-8fc9-315f8add34de":{"name":"page","in":"query","schema":{"oneOf":[{"type":"integer","minimum":1,"uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"integer | null"}},"5932d730-4aa2-4af3-9512-fe1666fd200a":{"name":"per_page","in":"query","schema":{"oneOf":[{"type":"integer","minimum":1,"maximum":100,"uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":100,"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"integer | null"}},"7f2e577e-4e60-47d8-90ef-e9e2257638f8":{"name":"type","in":"query","schema":{"oneOf":[{"type":"string","enum":["b2c","b2b"],"uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["b2c","b2b"],"uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"24077c1f-c8ab-4250-bdaa-b780a9046a6d":{"name":"convention_id","in":"query","schema":{"oneOf":[{"type":"integer","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"integer | null"}},"3186da01-383c-4ccd-8aed-cc208a71c404":{"name":"keyword","in":"query","description":"nécessaire lorque le chantier est crée par un mandataire","schema":{"oneOf":[{"type":"string","description":"nécessaire lorque le chantier est crée par un mandataire","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","description":"nécessaire lorque le chantier est crée par un mandataire","uniqueKey":"oneOf.1","typeLabel":"null"}],"uniqueKey":"","typeLabel":"string | null"}}},"responses":{"7732f977-b19a-48f3-859e-09e75d905c54":{"description":"`BeneficiaryCollection`","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"integer"},"root_id":{"type":"integer","isRequired":true,"uniqueKey":"data.items.[INDEX].root_id","typeLabel":"integer"},"type":{"type":"string","enum":["root","copy"],"isRequired":true,"uniqueKey":"data.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"worksite_id":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].worksite_id","typeLabel":"string"},"firstname":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].firstname","typeLabel":"string"},"lastname":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].lastname","typeLabel":"string"},"company_name":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].company_name","typeLabel":"string"},"siren":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].siren","typeLabel":"string"},"siret":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].siret","typeLabel":"string"},"address":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].address","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].city","typeLabel":"string"},"zipcode":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].zipcode","typeLabel":"string"},"country":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].country","typeLabel":"string"},"mobile_phone":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].mobile_phone","typeLabel":"string"},"phone":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].phone","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"data.items.[INDEX].email","typeLabel":"string"}},"required":["id","root_id","type","worksite_id","firstname","lastname","company_name","siren","siret","address","city","zipcode","country","mobile_phone","phone","email"],"title":"BeneficiaryResource","uniqueKey":"data.items.[INDEX]","typeLabel":"BeneficiaryResource · object"},"isRequired":true,"uniqueKey":"data","typeLabel":"BeneficiaryResource · object[]"}},"required":["data"],"title":"BeneficiaryCollection","uniqueKey":"","typeLabel":"BeneficiaryCollection · object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":123,"root_id":123,"type":"root","worksite_id":"\u003cstring>","firstname":"\u003cstring>","lastname":"\u003cstring>","company_name":"\u003cstring>","siren":"\u003cstring>","siret":"\u003cstring>","address":"\u003cstring>","city":"\u003cstring>","zipcode":"\u003cstring>","country":"\u003cstring>","mobile_phone":"\u003cstring>","phone":"\u003cstring>","email":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"bcf0ab1e-05cf-44a2-a8be-13e1fa2b82dc":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Errors overview.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"A detailed description of each field that failed validation.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"required":["message","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"af0d8742-acac-4471-b4d8-94172cc34675":{"url":"https://api.opx.co/partners","description":"Production"}}},"originalFileLocation":"api-reference/partners/api.json"},"subdomain":"opx","siteName":"OPX","title":"Beneficiaries list - OPX","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T04:56:38.695Z","originalFileLocation":"partners-api/beneficiaries/beneficiaries-list.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"OPX\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Beneficiaries list - OPX\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OPX\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://opx.mintlify.app/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Beneficiaries+list\u0026amp;theme=99af38e6c8e1ab7ef495ff8a\u0026amp;signature=f6fd7f1b233e5f334bd8022b0e56920782386fbe4697540f31d857a52df541a8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Beneficiaries list - OPX\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://opx.mintlify.app/_mintlify/api/og/v2?division=Beneficiaries\u0026amp;title=Beneficiaries+list\u0026amp;theme=99af38e6c8e1ab7ef495ff8a\u0026amp;signature=f6fd7f1b233e5f334bd8022b0e56920782386fbe4697540f31d857a52df541a8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/opx/dGb8qmtXvw14_Q6S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OPX\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1730BF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/partners-api/beneficiaries/beneficiaries-list.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.opx.co/#organization\",\"name\":\"OPX\",\"url\":\"https://docs.opx.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/opx/OMvPuuHV3xFuPVay/logo/opx-dark.svg?fit=max\u0026auto=format\u0026n=OMvPuuHV3xFuPVay\u0026q=85\u0026s=399ae365414d8cf0abb91632d4cda098\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.opx.co#website\",\"name\":\"OPX\",\"url\":\"https://docs.opx.co\",\"publisher\":{\"@id\":\"https://docs.opx.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list#webpage\",\"url\":\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list\",\"name\":\"Beneficiaries list\",\"dateModified\":\"2026-11-02T04:56:38.695Z\",\"isPartOf\":{\"@id\":\"https://docs.opx.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"OPX\",\"item\":\"https://docs.opx.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Beneficiaries list\",\"item\":\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list#apireference\",\"headline\":\"Beneficiaries list\",\"name\":\"Beneficiaries list\",\"url\":\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list\",\"mainEntityOfPage\":{\"@id\":\"https://docs.opx.co/partners-api/beneficiaries/beneficiaries-list#webpage\"},\"dateModified\":\"2026-11-02T04:56:38.695Z\",\"publisher\":{\"@id\":\"https://docs.opx.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.opx.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OPX\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OPX","nav":{"global":{"anchors":[{"anchor":"Features","icon":"globe","href":"https://www.opx.co/"},{"anchor":"Book a demo","icon":"hand-holding-heart","href":"https://www.opx.co/demo"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference (beta)","groups":[{"group":"ApprovedMaterials","pages":[{"title":"Approved materials list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/approved-materials","href":"/partners-api/approvedmaterials/approved-materials-list"},{"title":"Approved material details","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/approved-materials/{id}","href":"/partners-api/approvedmaterials/approved-material-details"}]},{"group":"Beneficiaries","pages":[{"title":"Beneficiaries list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/beneficiaries","href":"/partners-api/beneficiaries/beneficiaries-list"},{"title":"Beneficiary creation","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/beneficiaries","href":"/partners-api/beneficiaries/beneficiary-creation"},{"title":"Beneficiary details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/beneficiaries/{id}","href":"/partners-api/beneficiaries/beneficiary-details"},{"title":"Beneficiary update","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json put /v1/beneficiaries/{id}","href":"/partners-api/beneficiaries/beneficiary-update"},{"title":"Beneficiary deletion","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json delete /v1/beneficiaries/{id}","href":"/partners-api/beneficiaries/beneficiary-deletion"}]},{"group":"ContractsTemplates","pages":[{"title":"Contracts templates list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/contracts-templates","href":"/partners-api/contractstemplates/contracts-templates-list"},{"title":"Contract template details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/contracts-templates/{id}","href":"/partners-api/contractstemplates/contract-template-details"}]},{"group":"Conventions","pages":[{"title":"Conventions list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/conventions","href":"/partners-api/conventions/conventions-list"},{"title":"Convention creation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/conventions","href":"/partners-api/conventions/convention-creation"},{"title":"Convention details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/conventions/{id}","href":"/partners-api/conventions/convention-details"},{"title":"Convention operations list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/conventions/{id}/operations","href":"/partners-api/conventions/convention-operations-list"}]},{"group":"CustomWorksiteOperationStatus","pages":[{"title":"List custom worksite operation statuses","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/custom-worksite-operation-statuses","href":"/partners-api/customworksiteoperationstatus/list-custom-worksite-operation-statuses"}]},{"group":"Document","pages":[{"title":"Get available document types","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/documents/types","href":"/partners-api/document/get-available-document-types"},{"title":"Get available document statuses","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/documents/statuses","href":"/partners-api/document/get-available-document-statuses"}]},{"group":"Materials","pages":[{"title":"Materials list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/materials","href":"/partners-api/materials/materials-list"},{"title":"Material creation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/materials","href":"/partners-api/materials/material-creation"},{"title":"Material details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/materials/{id}","href":"/partners-api/materials/material-details"},{"title":"Material update","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json put /v1/materials/{id}","href":"/partners-api/materials/material-update"},{"title":"Material deletion","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json delete /v1/materials/{id}","href":"/partners-api/materials/material-deletion"}]},{"group":"Operations","pages":[{"title":"Operations list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/operations","href":"/partners-api/operations/operations-list"},{"title":"Operation details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/operations/{id}","href":"/partners-api/operations/operation-details"},{"title":"Operation Aids parameters list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/operations/{id}/parameters","href":"/partners-api/operations/operation-aids-parameters-list"},{"title":"Operation AH parameters list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/operations/{id}/parameters/attestation","href":"/partners-api/operations/operation-ah-parameters-list"}]},{"group":"Professionals","pages":[{"title":"Professionals list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/professionals","href":"/partners-api/professionals/professionals-list"},{"title":"Professional details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/professionals/{id}","href":"/partners-api/professionals/professional-details"},{"title":"Professional registration documents","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/professionals/{id}/documents","href":"/partners-api/professionals/professional-registration-documents"}]},{"group":"Subcontractors","pages":[{"title":"Subcontractors list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/subcontractors","href":"/partners-api/subcontractors/subcontractors-list"},{"title":"Subcontractor creation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/subcontractors","href":"/partners-api/subcontractors/subcontractor-creation"},{"title":"Subcontractor details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/subcontractors/{id}","href":"/partners-api/subcontractors/subcontractor-details"},{"title":"Subcontractor update","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json put /v1/subcontractors/{id}","href":"/partners-api/subcontractors/subcontractor-update"},{"title":"Subcontractor deletion","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json delete /v1/subcontractors/{id}","href":"/partners-api/subcontractors/subcontractor-deletion"}]},{"group":"Tags","pages":[{"title":"Tags list: system tags and the custom tags of the account and of its partners","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/tags","href":"/partners-api/tags/tags-list:-system-tags-and-the-custom-tags-of-the-account-and-of-its-partners"}]},{"group":"Utils","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/health-check","href":"/partners-api/utils/health-check"}]},{"group":"WorksiteTags","pages":[{"title":"Custom tags of a worksite","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/worksites/{id}/tags","href":"/partners-api/worksitetags/custom-tags-of-a-worksite"},{"title":"Replace the custom tags of a worksite, an empty list removes them all","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json put /v1/worksites/{id}/tags","href":"/partners-api/worksitetags/replace-the-custom-tags-of-a-worksite-an-empty-list-removes-them-all"},{"title":"Add custom tags to a worksite","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/worksites/{id}/tags","href":"/partners-api/worksitetags/add-custom-tags-to-a-worksite"},{"title":"Remove custom tags from a worksite","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json delete /v1/worksites/{id}/tags","href":"/partners-api/worksitetags/remove-custom-tags-from-a-worksite"},{"title":"Custom tags of a worksite operation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/worksites/{id}/operations/{worksite_operation_id}/tags","href":"/partners-api/worksitetags/custom-tags-of-a-worksite-operation"},{"title":"Replace the custom tags of a worksite operation, an empty list removes them all","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json put /v1/worksites/{id}/operations/{worksite_operation_id}/tags","href":"/partners-api/worksitetags/replace-the-custom-tags-of-a-worksite-operation-an-empty-list-removes-them-all"},{"title":"Add custom tags to a worksite operation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/worksites/{id}/operations/{worksite_operation_id}/tags","href":"/partners-api/worksitetags/add-custom-tags-to-a-worksite-operation"},{"title":"Remove custom tags from a worksite operation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json delete /v1/worksites/{id}/operations/{worksite_operation_id}/tags","href":"/partners-api/worksitetags/remove-custom-tags-from-a-worksite-operation"}]},{"group":"Worksites","pages":[{"title":"Worksites list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/worksites","href":"/partners-api/worksites/worksites-list"},{"title":"Worksite creation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/worksites","href":"/partners-api/worksites/worksite-creation"},{"title":"Worksite details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/worksites/{id}","href":"/partners-api/worksites/worksite-details"},{"title":"Worksite update","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json put /v1/worksites/{id}","href":"/partners-api/worksites/worksite-update"},{"title":"Worksite deletion","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json delete /v1/worksites/{id}","href":"/partners-api/worksites/worksite-deletion"}]},{"group":"WorksitesDocuments","pages":[{"title":"Worksite documents list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/worksites/{id}/documents","href":"/partners-api/worksitesdocuments/worksite-documents-list"},{"title":"Worksite document creation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/worksites/{id}/documents","href":"/partners-api/worksitesdocuments/worksite-document-creation"},{"title":"Worksite document show","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/worksites/{id}/documents/{document_id}","href":"/partners-api/worksitesdocuments/worksite-document-show"},{"title":"Worksite document update","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json put /v1/worksites/{id}/documents/{document_id}","href":"/partners-api/worksitesdocuments/worksite-document-update"},{"title":"Worksite document deletion","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json delete /v1/worksites/{id}/documents/{document_id}","href":"/partners-api/worksitesdocuments/worksite-document-deletion"}]},{"group":"WorksitesOperations","pages":[{"title":"Worksite operations list","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/worksites/{id}/operations","href":"/partners-api/worksitesoperations/worksite-operations-list"},{"title":"Worksite operation creation","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json post /v1/worksites/{id}/operations","href":"/partners-api/worksitesoperations/worksite-operation-creation"},{"title":"Worksite operation details","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json get /v1/worksites/{id}/operations/{worksite_operation_id}","href":"/partners-api/worksitesoperations/worksite-operation-details"},{"title":"Worksite operation update","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json put /v1/worksites/{id}/operations/{worksite_operation_id}","href":"/partners-api/worksitesoperations/worksite-operation-update"},{"title":"Worksite operation deletion","deprecated":null,"version":null,"openapi":"/api-reference/partners/api.json delete /v1/worksites/{id}/operations/{worksite_operation_id}","href":"/partners-api/worksitesoperations/worksite-operation-deletion"}]}]}]},"basePath":"","title":"Beneficiaries list - OPX","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}