Daylite WebsiteMarketcircle Blog
API Reference

Role Search

post
https://api.marketcircle.net/v1/roles/_search

Search for roles

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.

contact, company, opportunity, project and type can be matched in two ways:

  • By reference, with equal or not_equal:
    { "contact": { "equal": "/v1/contacts/1000" } }
  • By the linked record's attributes, with any and a search filter for that record type:
    { "company": { "any": { "name": { "equal": "Acme" } } } }
    { "type": { "any": { "role_name": { "equal": "Decision Maker" } } } }
Query Params
int32
≤ 250
Defaults to 50

Maximum number of results per page (max 250). Defaults to 50, or 10 when full-records is true.

boolean

Return every attribute of each result instead of the short list form.

int32

Return results whose ID is greater than or equal to this value. Use the next URL from the previous page rather than building this yourself.

Body Params
title
object

Example: Interim CEO

department
object

Example: Executive

contact
object

The contact. Match by reference with equal or not_equal, e.g. {"equal": "/v1/contacts/1000"}, or by any contact attribute with any, e.g. {"any": {"name": {"equal": "Acme"}}}.

company
object

The company. Match by reference with equal or not_equal, e.g. {"equal": "/v1/companies/1000"}, or by any company attribute with any, e.g. {"any": {"name": {"equal": "Acme"}}}.

opportunity
object

The opportunity. Match by reference with equal or not_equal, e.g. {"equal": "/v1/opportunities/1000"}, or by any opportunity attribute with any, e.g. {"any": {"name": {"equal": "Acme"}}}.

project
object

The project. Match by reference with equal or not_equal, e.g. {"equal": "/v1/projects/1000"}, or by any project attribute with any, e.g. {"any": {"name": {"equal": "Acme"}}}.

type
object

The role type. Match by reference with equal or not_equal, e.g. {"equal": "/v1/role_types/1000"}, or by any role type attribute with any, e.g. {"any": {"role_name": {"equal": "Decision Maker"}}}.

role_id
object

The role's numeric ID

Responses

Updated 10 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago