Get Client Integrations
GET
/v2/settings/clientintegrations
This endpoint retrieves a list of client integrations, representing schools that have authorized your integration in their d6+ SAMS instance.
Each record in the response corresponds to a unique client/API type combination, meaning a single school may appear multiple times if it has authorized multiple integrations.
Pagination
The response data includes a meta
object that contains pagination-specific metadata. You can use the following query parameters to control pagination:
limit: This parameter allows you to override the default limit of records returned, up to the
max_allowed_limit
specified in the response'smeta
object.cursor: If the
meta
object contains anext_cursor
field, it indicates that more records are available. To fetch the next set of records, include thecursor
parameter in your request with the value ofnext_cursor
. If thenext_cursor
field is not present, it means there are no more records to retrieve.reverse_order: This parameter can be used to reverse the order in which the data is returned, useful for fetching the latest records first.
Request Headers
HTTP-X-USERNAME
*
String
As provided by d6
HTTP-X-PASSWORD
*
String
As provided by d6
Query Parameters
school_id
Integer
Optional ID of the school to retrieve data from
api_type_id
Integer
For filtering on a specific API Type
cursor
Boolean
To retrieve the next group of items (if any)
limit
Integer
To override the default limit of records returned (up to the max_allowed_limit
provided in the response metadata).
reverse_order
Boolean
To reverse the order the data is returned in
Response Examples
Status: 200 OK