Agency roles
List an agency member's approved roles
curl -X GET "https://external-api.paraform.com/api/external/v1/agency/roles?recruiterEmail=jane@example.com&status=ACTIVE&limit=50" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"roles": [
{
"id": "string",
"title": "string",
"company": {
"name": "string"
},
"status": "ACTIVE",
"locations": [
"string"
],
"workplaceType": "REMOTE",
"baseSalary": {
"currency": "string",
"min": 0,
"max": 0
},
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"nextCursor": "string"
}
Required scopes:
Rate limit:
agency_roles:readRate limit:
default tier, 120 requests per minute per keyQuery parameters
string
required
Email of a currently approved member of the authenticated agency. Selects that member’s permissions; it does not authenticate the person holding the key.
Constraints: format
email, max length 254.string
Search permitted role titles and company display names within this member’s approved roles.
Constraints: min length 1, max length 200.
string
Use true or false. Defaults to false; true restricts to approved FULL-access primary slots.
Allowed values:
true, false.string
default:"ACTIVE"
CLOSED includes hired and churned roles. Pending, rejected, and disqualified roles are not exposed.
Allowed values:
ACTIVE, PAUSED, CLOSED.integer
default:"50"
Constraints: minimum 1, maximum 100.
string
Opaque continuation token. Reuse with the same agency, recruiter, query, primaryOnly, and status.
Constraints: min length 1, max length 2048.
Response
object[]
required
Show roles properties
Show roles properties
string
required
string
required
string
required
Allowed values:
ACTIVE, PAUSED, CLOSED.string[]
required
string | null
required
Allowed values:
REMOTE, HYBRID, ON_SITE.object | null
required
string
required
Constraints: format
date-time.string | null
required
curl -X GET "https://external-api.paraform.com/api/external/v1/agency/roles?recruiterEmail=jane@example.com&status=ACTIVE&limit=50" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"roles": [
{
"id": "string",
"title": "string",
"company": {
"name": "string"
},
"status": "ACTIVE",
"locations": [
"string"
],
"workplaceType": "REMOTE",
"baseSalary": {
"currency": "string",
"min": 0,
"max": 0
},
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"nextCursor": "string"
}
⌘I
curl -X GET "https://external-api.paraform.com/api/external/v1/agency/roles?recruiterEmail=jane@example.com&status=ACTIVE&limit=50" \
-H "Authorization: Bearer $PARAFORM_API_KEY"
{
"roles": [
{
"id": "string",
"title": "string",
"company": {
"name": "string"
},
"status": "ACTIVE",
"locations": [
"string"
],
"workplaceType": "REMOTE",
"baseSalary": {
"currency": "string",
"min": 0,
"max": 0
},
"updatedAt": "2024-01-01T00:00:00.000Z"
}
],
"nextCursor": "string"
}