For Developers

Fetch Rule

GET https://ed.link/api/v2/teams/:team_id/integrations/:integration_id/rules/:rule_id

Retrieves a single rule including all attached condition criteria.

Permissions

Requires the rules.read system permission.

Parameters

ParameterTypeRequiredDescription
:team_idUUIDYesThe ID of the team.
:integration_idUUIDYesThe ID of the integration.
:rule_idUUIDYesThe ID of the rule.

Sample Request

const response = await axios.get(`https://ed.link/api/v2/teams/${team_id}/integrations/${integration_id}/rules/${rule_id}`, {
    headers: {
        authorization: `Bearer ${user_session_token}`
    }
});

Sample Response

{
    "$data": {
        "id": "7ca194a2-1982-4f91-8841-59128aa10234",
        "name": "Only High School Students",
        "state": "active",
        "target": "people",
        "conditions": [
            {
                "target": "person",
                "property": "grade_levels",
                "operator": "IN",
                "values": ["09", "10", "11", "12"]
            }
        ]
    }
}