View as Markdown
Enrich Layer icon

Enrich Layer ACTION

Get Student Listing

Get a list of students of a school. Cost: 3 credits per student returned. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Enrich Layer account once, then configure and run Get Student Listing from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "enrich_layer-get-student-listing",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    enrich_layer: { authProvisionId: "apn_xxxxxxx" },
    schoolUrl: "School Profile URL",
    enrichProfiles: "Enrich Profiles",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Student Listing inputs
Property Type Description
schoolUrl School Profile URL string
The professional network URL of the school (e.g., https://www.linkedin.com/school/stanford-university).
Required
enrichProfiles Enrich Profiles string
Get the full profile data instead of only profile URLs. enrich adds 1 credit per result.
Optional
booleanSearchKeyword Boolean Search Keyword string
Filter students by their major using boolean search expression (e.g., computer OR cs). Max 255 characters. Costs 10 base credits + 6 credits per student.
Optional
country Country string
Filter students by country. Costs an extra 3 credits per result.
Optional
pageSize Page Size integer
Maximum number of results returned per API call. Defaults to 10.
Optional
studentStatus Student Status string
Filter by student status.
Optional
sortBy Sort By string
Sort students by matriculation or graduation dates. Adds 50 credits base + 10 credits per student.
Optional
resolveNumericId Resolve Numeric ID boolean
Enable support for school profile URLs with numerical IDs. Costs 2 extra credits.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
enrich_layer-get-student-listing
Version
0.0.2
App
Enrich Layer
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes