PCRecruiter API
Search... K

Appearance

Companies ​

Description ​

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

In PCRecruiter, a Company represents any organization or logical grouping. While often used for employers and client firms, a Company record can also represent a department, division, recruiting team, or any other entity that groups Candidates and Positions together. Candidates are linked to a Company via the CompanyId field, and Positions are associated with the Company they belong to.

Base Operations ​

These operations work with the main companiesv2 records.

GET - Search for Company records

POST - Create a(n) Company record

PUT - Update a(n) Company record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • CompanyId (integer,null, int64) -
  • ReplicationId (string) -
  • CompanyName (string) -
  • UserName (string) -
  • Address (string) -
  • Address2 (string) -
  • City (string) -
  • State (string) -
  • PostalCode (string) -
  • FullPostalCode (string) -
  • PostalCodeExtension (string) -
  • County (string) -
  • Country (string) -
  • Phone (string) -
  • Fax (string) -
  • DateEntered (null,string, date-time) -
  • EmailWWWAddress (string) -
  • DefaultCurrency -
  • IndustryCode (string) -
  • NumberOfEmployees (null,number, double) -
  • AnnualRevenue -
  • FeeCollected -
  • DivisionOf (string) -
  • CompanyType -
  • Industry (string) -
  • Specialty (string) -
  • Subjective (integer,null, int32) -
  • Keywords (string) -
  • Summary (string) -
  • Notes (string) -
  • HasNotes (boolean,null) -
  • LastActivity (null,string, date-time) -
  • LastModified (null,string, date-time) -
  • Identification (string) -
  • PrivateNotes (string) -
  • Logo (string, byte) -
  • Candidates (array) -
  • CustomFields (array) -
  • EEOC (array) -
  • Activities (array) -
  • RollupLists (array) -
  • Attachments (array) -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2?Query=CompanyName eq Acme Corporation&Fields=CompanyId,CompanyName,UserName,DateEntered",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "TotalRecords": 2,
  "Results": [
    {
      "CompanyId": 12345,
      "CompanyName": "Acme Corporation",
      "UserName": "ADMIN",
      "DateEntered": 	"2025-11-12T16:40:40",
    },
    {
      "CompanyId": 12345,
      "CompanyName": "Acme Corporation",
      "UserName": "ADMIN",
      "DateEntered": "2025-11-12T16:40:40,
    }
  ]
}

TIP

This API call returns a paginated list of records that match the supplied query. Use Query parameter to filter results, Page and ResultsPerPage to control pagination, Fields to control the returned fields, and Order to sort results.

------------------ REQUEST ------------------- ​
json
{
  "method": "POST",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "CompanyName": "PCRecruiter",
    "UserName": "SAMPLE",
    "Address": "4420 Sherwin Road",
    "Address2": null,
    "City": "Willoughby",
    "State": "OH",
    "PostalCode": "44094",
    "FullPostalCode": "44094",
    "PostalCodeExtension": null,
    "County": null,
    "Country": null,
    "Phone": "(440) 946-5214",
    "Fax": null,
    "DateEntered": "2025-02-05T14:13:01.797",
    "EmailAddress": null,
    "Website": "https://www.pcrecruiter.net/site",
    "DefaultCurrency": "USD",
    "IndustryCode": null,
    "NumberOfEmployees": null,
    "AnnualRevenue": null,
    "CompanyType": "NotSpecified",
    "Industry": null,
    "Specialty": null,
    "Subjective": null,
    "LastActivity": "2025-02-05T14:13:02",
    "LastModified": "2025-02-05T14:13:01",
    "Identification": "CO-6163780848",
    "CustomFields": []
}
}
------------------ RESPONSE ------------------ ​
json
{
"CompanyId": 944821946831671
}

TIP

This API call creates a new record. Include the required fields in the request body. The response will contain the created record with its newly assigned ID.

------------------ REQUEST ------------------- ​
json
{
  "method": "PUT",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/{CompanyId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "CompanyName": "Acme Corporation"
  }
}
------------------ 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) Company record

PUT - Update a(n) Company record

DELETE - Delete a(n) Company record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • CompanyId (integer,null, int64) -
  • ReplicationId (string) -
  • CompanyName (string) -
  • UserName (string) -
  • Address (string) -
  • Address2 (string) -
  • City (string) -
  • State (string) -
  • PostalCode (string) -
  • FullPostalCode (string) -
  • PostalCodeExtension (string) -
  • County (string) -
  • Country (string) -
  • Phone (string) -
  • Fax (string) -
  • DateEntered (null,string, date-time) -
  • EmailWWWAddress (string) -
  • DefaultCurrency -
  • IndustryCode (string) -
  • NumberOfEmployees (null,number, double) -
  • AnnualRevenue -
  • FeeCollected -
  • DivisionOf (string) -
  • CompanyType -
  • Industry (string) -
  • Specialty (string) -
  • Subjective (integer,null, int32) -
  • Keywords (string) -
  • Summary (string) -
  • Notes (string) -
  • HasNotes (boolean,null) -
  • LastActivity (null,string, date-time) -
  • LastModified (null,string, date-time) -
  • Identification (string) -
  • PrivateNotes (string) -
  • Logo (string, byte) -
  • Candidates (array) -
  • CustomFields (array) -
  • EEOC (array) -
  • Activities (array) -
  • RollupLists (array) -
  • Attachments (array) -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/{id}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "CompanyName": "PCRecruiter",
    "UserName": "SAMPLE",
    "Address": "4420 Sherwin Road",
    "Address2": null,
    "City": "Willoughby",
    "State": "OH",
    "PostalCode": "44094",
    "FullPostalCode": "44094",
    "PostalCodeExtension": null,
    "County": null,
    "Country": null,
    "Phone": "(440) 946-5214",
    "Fax": null,
    "DateEntered": "2025-02-05T14:13:01.797",
    "EmailAddress": null,
    "Website": "https://www.pcrecruiter.net/site",
    "DefaultCurrency": "USD",
    "IndustryCode": null,
    "NumberOfEmployees": null,
    "AnnualRevenue": null,
    "CompanyType": "NotSpecified",
    "Industry": null,
    "Specialty": null,
    "Subjective": null,
    "LastActivity": "2025-02-05T14:13:02",
    "LastModified": "2025-02-05T14:13:01",
    "Identification": "CO-6163780848",
    "CustomFields": []
}

TIP

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

------------------ REQUEST ------------------- ​
json
{
  "method": "DELETE",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/123456",
  "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.

Activities ​

Manage activities data associated with companiesv2 records.

GET - Search for Company Activity records

POST - Create a(n) Company Activity record

PUT - Update a(n) Company Activity record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • ActivityId (integer,null, int64) -
  • CompanyId (integer,null, int64) -
  • UserName (string) -
  • DateEntered (null,string, date-time) -
  • Memo (string) -
  • ActType (string) -
  • Result (string) -
  • FormId (integer,null, int64) -
  • Company -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/activities?Query=CompanyId eq 944821946831671",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "TotalRecords": 2,
    "Results": [
        {
            "ActivityId": 381639614134627,
            "CompanyId": 944821946831671,
            "UserName": "SAMPLE",
            "DateEntered": "2025-11-12T13:26:55.06",
            "Memo": "Company (Acme Corporation) was updated via API. (Wed Nov-12 '25 1:26p/JAKE)",
            "ActType": "SAVECOM",
            "Result": null
        },
        {
            "ActivityId": 601479046666901,
            "CompanyId": 944821946831671,
            "UserName": "SAMPLE",
            "DateEntered": "2025-11-12T13:25:54.25",
            "Memo": "Company was created via API. (Wed Nov-12 '25 1:25p/JAKE)",
            "ActType": "ADDCOM",
            "Result": null
        }
    ]
}

TIP

This API call returns a paginated list of records for the CompanyId supplied in the query.

------------------ REQUEST ------------------- ​
json
{
  "method": "POST",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/activities/",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "CompanyId": 944821946831671,
    "UserName": "SAMPLE",
    "Memo": "This is some sample Activity Text"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "ActivityId": 163349721393211
}

TIP

This API call creates a new activity record associated with the CompanyId supplied in the request body. Include the required fields in the request body. The response will contain the created record assigned ID.

------------------ REQUEST ------------------- ​
json
{
  "method": "PUT",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/activities/{ActivityId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "UserName": "SAMPLE",
    "Memo": "This is the changed Activity Text"
  }
}
------------------ 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) Company Activity record

PUT - Update a(n) Company Activity record

DELETE - Delete a(n) Company Activity record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • ActivityId (integer,null, int64) -
  • CompanyId (integer,null, int64) -
  • UserName (string) -
  • DateEntered (null,string, date-time) -
  • Memo (string) -
  • ActType (string) -
  • Result (string) -
  • FormId (integer,null, int64) -
  • Company -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/activities/{Activityid}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "ActivityId": 601479046666901,
  "CompanyId": 944821946831671,
  "UserName": "SAMPLE",
  "DateEntered": "2025-11-12T13:25:54.25",
  "Memo": "Company was created via API. (Wed Nov-12 '25 1:25p/JAKE)",
  "ActType": "ADDCOM",
  "Result": null
}

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": "PUT",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/activities/{Activityid}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "UserName": "SAMPLE",
    "Memo": "This is the changed Activity Text"
  }
}
------------------ 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.

------------------ REQUEST ------------------- ​
json
{
  "method": "DELETE",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/activities/123456",
  "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.

Attachments ​

Manage attachments data associated with companiesv2 records.

GET - Search for Company Attachment records

POST - Create a(n) Company Attachment record

PUT - Update a(n) Company Attachment record

Data Parameters ​

  • AttachmentId (integer,null, int64) -
  • Type -
  • Name (string) -
  • Description (string) -
  • Date (null,string, date-time) -
  • ProfileLink (string) -
  • ProfileLinkEdit (string) -
  • Hash (string) -
  • Data (string, byte) -
  • Size (integer,null, int64) -
  • TokenId (integer,null, int64) -
  • AggregateCount (integer,null, int32) -
  • MetaData -
  • CompanyId (integer,null, int64) -
  • Company -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/attachments?Query=CompanyId eq 944821946831671",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "TotalRecords": 2,
    "Results": [
        {
            "CompanyId": 944821946831671,
            "AttachmentId": 114032831132980,
            "Type": "UPLOAD",
            "Name": "Records Merged 09-07-2023.txt",
            "Description": "Record merged again",
            "Date": "2024-09-10T17:15:45.737",
            "Size": 7869
        },
        {
            "CompanyId": 944821946831671,
            "AttachmentId": 125485991974203,
            "Type": "UPLOAD",
            "Name": "Records Merged 09-07-2023.txt",
            "Description": "Record merged on 9/7/2023 12:23:18 PM",
            "Date": "2023-09-07T12:23:18.147",
            "Size": 7869
        }
    ]
}

TIP

This API call returns a paginated list of records. Use Query parameter to filter results, Page and ResultsPerPage to control pagination, and Order to sort results.

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/companiesV2/attachments/{AttachmentId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "CompanyId": 944821946831671,
    "AttachmentId": 125485991974203,
    "Type": "UPLOAD",
    "Name": "Records Merged 09-07-2023.txt",
    "Description": "Record merged on 9/7/2023 12:23:18 PM",
    "Date": "2023-09-07T12:23:18.147",
    "Size": 7869
}

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.

Rolluplists ​

Manage rolluplists data associated with companiesv2 records.

GET - Search for Rollup Company records

POST - Create a(n) Rollup Company record

PUT - Update a(n) Rollup Company record

Data Parameters ​

  • AggregateCount (integer,null, int32) -
  • MetaData -
  • CompanyId (integer,null, int64) -
  • Code (string) -
  • Stage -
  • Rank (integer,null, int32) -
  • Comments (string) -
  • DateEntered (null,string, date-time) -
  • LastModified (null,string, date-time) -
  • DateRead (null,string, date-time) -
  • SortDistance (null,number, double) -
  • Company -
  • RollupList -

Examples ​

------------------ REQUEST ------------------- ​
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/CompaniesV2/RollupLists?Query=CompanyId eq 130675937475340",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
    "TotalRecords": 2,
    "Results": [
        {
            "CompanyId": 130675937475340,
            "Code": "SAMPLE.0054",
            "Stage": "None",
            "Rank": 0,
            "Comments": null,
            "DateEntered": "2019-09-26T13:39:19",
            "LastModified": null
        },
        {
            "CompanyId": 130675937475340,
            "Code": "SAMPLE.0124",
            "Stage": "None",
            "Rank": 0,
            "Comments": null,
            "DateEntered": "2019-09-26T13:39:20",
            "LastModified": null
        }
    ]
}

TIP

This API call returns a paginated list of rollup records for the supplied CompanyId in the query.

------------------ REQUEST ------------------- ​
json
{
  "method": "POST",
  "url": "https://www2.pcrecruiter.net/rest/api/CompaniesV2/RollupLists/",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "CompanyId": 130675937475340,
    "Code": "SAMPLE.0018"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "Success": true
}

TIP

This API call associates the supplied CompanyId with the supplied Rollup Code. This does not create a new Rollup record and only acts to associate the records and add the company to the Rollup list.