Skip to content
/business-policies

List all business policy groups

Request

🔒 Private label — contact sales. Requires a private-label entitlement on your API client.

Returns all policy groups configured for the authenticated business, each containing their associated policies and rules.

Security
oauth2ClientCredentials(Required scopes: business-policies:read)
Headers
business_idstringrequired

Business identifier for the request

curl -i -X GET \
  https://developer.boyahq.com/_mock/v2/openapi/business-policies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'business_id: string'

Responses

Policy groups returned successfully

Bodyapplication/json
Array [
_idstring

Policy group MongoDB ObjectId

descriptionstring

Description of what this policy group governs

subjectstring

Subject area of the policy group (e.g. Employee Spend, Expense Review)

policiesArray of objects(PolicySummaryInGroupV1Dto)

Policy types within this group

createdAtstring

ISO 8601 creation timestamp

updatedAtstring

ISO 8601 last-updated timestamp

]
Response
[
  {
    "_id": "string",
    "description": "string",
    "subject": "string",
    "policies": [ … ],
    "createdAt": "string",
    "updatedAt": "string"
  }
]