API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

coordinates

Retrieves the collection of coordinates resources.

Retrieves the collection of coordinates 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[location]
boolean
exists[bills]
boolean
exists[language]
boolean
exists[mbti]
boolean
exists[contactsFullName]
boolean
exists[contactsTitle]
boolean
exists[contactsEmail]
boolean
exists[contactsWebsite]
boolean
exists[contactsTel]
boolean
exists[contactsFax]
boolean
exists[contactsCell]
boolean
exists[contactsPage]
boolean
exists[birthday]
boolean
exists[invoices]
boolean
exists[notes]
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[priority]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[contactsFullName]
string
Default: "asc"
Enum: "asc" "desc"
order[contactsTitle]
string
Default: "asc"
Enum: "asc" "desc"
order[contactsEmail]
string
Default: "asc"
Enum: "asc" "desc"
order[contactsWebsite]
string
Default: "asc"
Enum: "asc" "desc"
order[contactsTel]
string
Default: "asc"
Enum: "asc" "desc"
order[contactsFax]
string
Default: "asc"
Enum: "asc" "desc"
order[contactsCell]
string
Default: "asc"
Enum: "asc" "desc"
order[contactsPage]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[reachable]
string
Default: "asc"
Enum: "asc" "desc"
order[newsletter]
string
Default: "asc"
Enum: "asc" "desc"
order[birthday]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
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"
birthday[before]
string
birthday[strictly_before]
string
birthday[after]
string
birthday[strictly_after]
string
contactsCell_end_with
string
contactsCell_partial
string
contactsCell_start_with
string
contactsCell
string
contactsCell[]
Array of strings
contactsEmail_end_with
string
contactsEmail_partial
string
contactsEmail_start_with
string
contactsEmail
string
contactsEmail[]
Array of strings
contactsFax_end_with
string
contactsFax_partial
string
contactsFax_start_with
string
contactsFax
string
contactsFax[]
Array of strings
contactsFullName_end_with
string
contactsFullName_partial
string
contactsFullName_start_with
string
contactsFullName
string
contactsFullName[]
Array of strings
contactsPage_end_with
string
contactsPage_partial
string
contactsPage_start_with
string
contactsPage
string
contactsPage[]
Array of strings
contactsTel_end_with
string
contactsTel_partial
string
contactsTel_start_with
string
contactsTel
string
contactsTel[]
Array of strings
contactsTitle_end_with
string
contactsTitle_partial
string
contactsTitle_start_with
string
contactsTitle
string
contactsTitle[]
Array of strings
contactsWebsite_end_with
string
contactsWebsite_partial
string
contactsWebsite_start_with
string
contactsWebsite
string
contactsWebsite[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[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
gender
string
gender[]
Array of strings
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
language
string
language[]
Array of strings
newsletter
boolean
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
person
string
person[]
Array of strings
priority_range[between]
string
priority_range[gt]
string
priority_range[gte]
string
priority_range[lt]
string
priority_range[lte]
string
priority
integer
priority[]
Array of integers
reachable
boolean
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
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": {
    }
}