PCRecruiter API
Search... K

Appearance

Rolluplists ​

Description ​

The rolluplistsv2 endpoint is used to manage rollup list records in PCRecruiter. You can retrieve, create, update, and delete records using standard REST operations.

Rollup lists are a way to group records onto a list. Rollup lists can contain records of each type Candidates, Companies, and Positions.

NOTE

Rollup Stages (and the related stage template endpoints) are available in PCR 9 but do not exist in PCRM, where they have been replaced by Simple Sequences.

Base Operations ​

These operations work with the main rolluplistsv2 records.

GET - Search for Rollup List records

POST - Create a(n) Rollup List record

PUT - Update a(n) Rollup List record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • Code (string) -
  • Description (string) -
  • Memo (string) -
  • UserName (string) -
  • Owner (string) -
  • Category (string) -
  • Shared (boolean,null) -
  • DateEntered (null,string, date-time) -
  • ActType (string) -
  • GlobalStageTemplate (string) -
  • RollupCompanies (array) -
  • RollupCandidates (array) -
  • RollupPositions (array) -
  • Sequence -
  • CandidateCount (integer,null, int32) -
  • CompanyCount (integer,null, int32) -
  • PositionCount (integer,null, int32) -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/RollupListsV2?Query=Description eq all open positions",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "TotalRecords": 1,
    "Results": [
        {
            "Code": "SAMPLE.0007",
            "Description": "all open positions",
            "Memo": null,
            "UserName": "SAMPLE",
            "Owner": "SAMPLE",
            "Category": null,
            "Shared": true,
            "DateEntered": "2008-10-17T11:26:17",
            "ActType": null,
            "GlobalStageTemplate": null,
            "CandidateCount": 3,
            "CompanyCount": 0,
            "PositionCount": 49
        }
    ]
}

TIP

This API call returns a paginated list of records that matched the supplied query. The Description field will be the name of the Rollup list you are searching for.

------------------ REQUEST ------------------- ​
json
{
  "method": "POST",
  "url": "https://www2.pcrecruiter.net/rest/api/RollupListsV2/",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
            "Description": "This is my sample Rollup",
            "UserName": "SAMPLE",
            "Owner": "SAMPLE",
            "Shared": true,
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "Code": "SAMPLE.0277"
}

TIP

This API call creates a new empty Rollup list record. You can then use the returned Rollup code to associate records to this Rollup list.

------------------ REQUEST ------------------- ​
json
{
  "method": "PUT",
  "url": "https://www2.pcrecruiter.net/rest/api/RollupListsV2/{Rollup Code}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
            "Description": "This is my sample altered Rollup",
            "Shared": false,
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "Success": true
}

TIP

This API call updates an existing record. Include the fields you want to modify in the request body. Only the provided fields will be updated.

GET - Retrieve a(n) Rollup List record

PUT - Update a(n) Rollup List record

DELETE - Delete a(n) Rollup List record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • Code (string) -
  • Description (string) -
  • Memo (string) -
  • UserName (string) -
  • Owner (string) -
  • Category (string) -
  • Shared (boolean,null) -
  • DateEntered (null,string, date-time) -
  • ActType (string) -
  • GlobalStageTemplate (string) -
  • RollupCompanies (array) -
  • RollupCandidates (array) -
  • RollupPositions (array) -
  • Sequence -
  • CandidateCount (integer,null, int32) -
  • CompanyCount (integer,null, int32) -
  • PositionCount (integer,null, int32) -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/RollupListsV2/{Rollup Code}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "Code": "SAMPLE.0277",
    "Description": "This is my sample Rollup",
    "Memo": null,
    "UserName": "SAMPLE",
    "Owner": "SAMPLE",
    "Category": null,
    "Shared": true,
    "DateEntered": "2025-11-12T14:46:57.857",
    "ActType": null,
    "GlobalStageTemplate": null,
    "CandidateCount": 0,
    "CompanyCount": 0,
    "PositionCount": 0
}

TIP

This API call retrieves a specific record by its ID. Use query parameters like Fields or Custom to control which fields are returned in the response.

------------------ REQUEST ------------------- ​
json
{
  "method": "DELETE",
  "url": "https://www2.pcrecruiter.net/rest/api/RollupListsV2/{Rollup Code}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "Success": true
}

TIP

This API call permanently deletes the specified record. This action cannot be undone.