Skip to main content

Platform API Functionality

Overview​

Talroo's Platform API supports a variety of RESTful API functionality including searching, sorting, and pagination when querying for more than one object.

Search is supported on the API with the search query parameter. Parameter values must be URL encoded. Any field can be searched on and the supported search operators can be seen below along with syntax examples:

Comparison Operators​

  • EQUALS: Find where a field equals a provided value
    • Operators: = or ==
    • Decoded Example: &search=company="Talroo"
    • Encoded Example: &search=company%3D%22Talroo%22
  • NOT EQUALS: Find where a field does not equal a provided value
    • Decoded Example: &search=company!="Talroo"
    • Encoded Example: &search=company%21%3D%22Talroo%22
  • GREATER THAN: Find where a field is greater than a provided value
    • Decoded Example: &search=budget>1000
    • Encoded Example: &search=budget%3E1000
  • GREATER THAN OR EQUAL: Find where a field is greater than or equal to a provided value
    • Decoded Example: &search=budget>=1000
    • Encoded Example: &search=budget%3E%3D1000
  • LESS THAN: Find where a field is less than a provided value
    • Decoded Example: &search=budget<5000
    • Encoded Example: &search=budget%3C5000
  • LESS THAN OR EQUAL: Find where a field is less than or equal to a provided value
    • Decoded Example: &search=budget<=5000
    • Encoded Example: &search=budget%3C%3D5000
  • LIKE: Find where a field contains a provided value (partial match)
    • Decoded Example: &search=company~"tal"
    • Encoded Example: &search=company~%22tal%22
  • IN: Find where a field matches any value in a provided list
    • Decoded Example: &search=company:("Jobs2Careers", "Talroo")
    • Encoded Example: &search=company%3A%28%22Jobs2Careers%22%2C%20%22Talroo%22%29
  • Negate: Filter OUT records matching the field search
    • Decoded Example: &search=-company:("Jobs2Careers", "Talroo")
    • Encoded Example: &search=-company%3A%28%22Jobs2Careers%22%2C%20%22Talroo%22%29

Logical Operators​

  • AND: Combine multiple conditions where all must be true
    • Operators: &&, AND, or and
    • Decoded Example: &search=company="Talroo" && title~"test"
      • Note the spaces between the operators
    • Encoded Example: &search=company%3D%22Talroo%22%20%26%26%20title~%22test%22
  • OR: Combine multiple conditions where at least one must be true
    • Operators: ||, OR, or or
    • Decoded Example: &search=company="Talroo" || title~"test"
    • Encoded Example: &search=company%3D%22Talroo%22%20%7C%7C%20title~%22test%22

Grouping Operations​

You can use parentheses to group operations and control the order of evaluation when combining AND and OR operators:

  • Decoded Example: &search=(company="Amazon" || company="UPS") && budget>=1000
  • Encoded Example: &search=%28company%3D%22Amazon%22%20%7C%7C%20company%3D%22UPS%22%29%20%26%26%20budget%3E%3D1000

These operators can be used in combination to find the specific set of jobs you are looking for. For example, the search parameter value below would return jobs (in a call to retrieve jobs) with a title like "warehouse" from the companies "Amazon" OR "UPS" and within the state of Texas (must use abbreviation)

  • Decoded Example: &search=company:("UPS", "Amazon") && title~"warehouse" && states="TX"
  • Encoded Example: &search=company%3A%28%22UPS%22%2C%20%22Amazon%22%29%20%26%26%20title~%22warehouse%22%20%26%26%20states%3D%22TX%22

Sort​

Sorting results is supported with the sort parameter. You can sort by one or more fields in ASC and DESC order using a new sort parameter for each field you would like to sort by, and a , after the field name followed by the sort direction.

The below example shows how you could utilize the sort parameter to order a result set in ascending order of campaignName, followed by descending order of title.

  • Decoded Example: &sort=campaignName&sort=title,desc
  • Encoded Example: &sort=campaignName&sort=title%2Cdesc

Pagination​

In order to keep API requests timely and result sets manageable, the Platform API utilizes pagination. For calls that return an array of objects, you can pass the size and page query parameters to indicate how large your result pages should be and which page you would like returned.

note

By default our results are paginated with a size of 20 and a page of 0

The below example shows how you could increase the response's results page size to 100, and have the second page of results returned, in order to get the second set of 100 results for your query:

  • Decoded Example: page=0&size=100
  • Decoded Example: page=0&size=100