Passages
Required scopes
This endpoint requires the following scopes:
- : Read passages
Authorizations
OAuth2clientCredentialsRequiredToken URL:
OAuth 2.0 Client Credentials. Exchange your client_id/client_secret at the token URL for a short-lived Bearer token, then call the API with it.
Path parameters
bank_idintegerRequired
Query parameters
sortstringOptional
Comma-separated; prefix with - for descending. Allowed: created_at.
page[number]integerOptional
page[size]integer · max: 100Optional
Responses
200
passages listed
application/json
metaobjectOptional
linksobjectOptional
401
missing or invalid token
application/json
403
token valid but lacks the passages:read scope
application/json
404
bank not shared with the caller district
application/json
422
invalid pagination parameter
application/json
get/api/v2/banks/{bank_id}/passages
GET /api/v2/banks/{bank_id}/passages HTTP/1.1
Host: api.masteryconnect.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"data": [
{
"id": "text",
"type": "text",
"attributes": {},
"relationships": {}
}
],
"meta": {},
"links": {}
}Required scopes
This endpoint requires the following scopes:
- : Read passages
Authorizations
OAuth2clientCredentialsRequiredToken URL:
OAuth 2.0 Client Credentials. Exchange your client_id/client_secret at the token URL for a short-lived Bearer token, then call the API with it.
Path parameters
bank_idintegerRequired
idintegerRequired
Responses
200
passage found
application/json
dataobjectOptional
404
passage not in the bank
application/json
get/api/v2/banks/{bank_id}/passages/{id}
GET /api/v2/banks/{bank_id}/passages/{id} HTTP/1.1
Host: api.masteryconnect.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"data": {}
}Last updated
Was this helpful?