Contexts
1. List Contexts
Returns a list of all data contexts.
URL:
/lighthouse/orgs/{org_id}/businesses/{business_id}/contexts
Method:
GET
Description: Retrieves a paginated list of contexts.
Query Params
Name
Type
Required
Description
page
integer
No
Page number (default: 1)
page_size
integer
No
Number of results per page (default: 10, max: 100)
search
string
No
Key used as search filter
Notes on Parameters
page_size: If the value provided is greater than 100, it will automatically be converted to the limit value.
Example Request
curl -X GET https://api.piercloud.io/lighthouse/orgs/{org_id}/businesses/{business_id}/contexts \
-H "Authorization: Bearer "
Successful Response (200 OK)
{
"code": "success",
"data": {
"contexts": [
{
"id": "uuid",
"name": "Amazon Web Services",
"provider": "aws",
"currency": "USD",
"is_default": true,
"business_id": "uuid"
}
],
"total": 1
}
}
Error Response (400 Bad Request)
{
"code": "bad-request/invalid-parameters",
"message": "error message"
}
Error Response (401 Unauthorized)
{
"code": "failed",
"message": "invalid or expired token"
}
Error Response (403 Forbidden)
{
"code": "authorization/forbidden",
"message": "Unable to give access to the user"
}
Last updated