API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_prospects

Retrieves the collection of person_prospects resources.

Retrieves the collection of person_prospects resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[referencedBy]
boolean
exists[internalabbreviation]
boolean
exists[type]
boolean
exists[industry]
boolean
exists[expertise]
boolean
exists[neq]
boolean
exists[icriq]
boolean
exists[projectType]
boolean
exists[notes]
boolean
exists[competitor]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[referencedBy]
string
Default: "asc"
Enum: "asc" "desc"
order[internalabbreviation]
string
Default: "asc"
Enum: "asc" "desc"
order[competitor]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[expertise]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[neq]
string
Default: "asc"
Enum: "asc" "desc"
order[icriq]
string
Default: "asc"
Enum: "asc" "desc"
order[nbEmployees]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[turnover]
string
Default: "asc"
Enum: "asc" "desc"
order[distance]
string
Default: "asc"
Enum: "asc" "desc"
order[budget]
string
Default: "asc"
Enum: "asc" "desc"
order[potential]
string
Default: "asc"
Enum: "asc" "desc"
order[creationDate]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
budget_range[between]
string
budget_range[gt]
string
budget_range[gte]
string
budget_range[lt]
string
budget_range[lte]
string
budget
string
budget[]
Array of strings
competitor_end_with
string
competitor_partial
string
competitor_start_with
string
competitor
string
competitor[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
creationDate[before]
string
creationDate[strictly_before]
string
creationDate[after]
string
creationDate[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
distance_range[between]
string
distance_range[gt]
string
distance_range[gte]
string
distance_range[lt]
string
distance_range[lte]
string
distance
string
distance[]
Array of strings
employee
string
employee[]
Array of strings
expertise_end_with
string
expertise_partial
string
expertise_start_with
string
expertise
string
expertise[]
Array of strings
icriq_range[between]
string
icriq_range[gt]
string
icriq_range[gte]
string
icriq_range[lt]
string
icriq_range[lte]
string
icriq
integer
icriq[]
Array of integers
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
industry
string
industry[]
Array of strings
internalabbreviation_end_with
string
internalabbreviation_partial
string
internalabbreviation_start_with
string
internalabbreviation
string
internalabbreviation[]
Array of strings
nbEmployees_range[between]
string
nbEmployees_range[gt]
string
nbEmployees_range[gte]
string
nbEmployees_range[lt]
string
nbEmployees_range[lte]
string
nbEmployees
integer
nbEmployees[]
Array of integers
neq_range[between]
string
neq_range[gt]
string
neq_range[gte]
string
neq_range[lt]
string
neq_range[lte]
string
neq
integer
neq[]
Array of integers
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
person
string
person[]
Array of strings
potential_range[between]
string
potential_range[gt]
string
potential_range[gte]
string
potential_range[lt]
string
potential_range[lte]
string
potential
string
potential[]
Array of strings
projectType
string
projectType[]
Array of strings
referencedBy_end_with
string
referencedBy_partial
string
referencedBy_start_with
string
referencedBy
string
referencedBy[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
status
string
status[]
Array of strings
turnover_range[between]
string
turnover_range[gt]
string
turnover_range[gte]
string
turnover_range[lt]
string
turnover_range[lte]
string
turnover
string
turnover[]
Array of strings
type
string
type[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}