Skip to main content
GET
/
api
/
v1
/
local_centers
Error
A valid request URL is required to generate request examples
{
  "hydra:member": [
    {
      "@id": "<string>",
      "@type": "<string>",
      "legalNumber": "<string>",
      "geoLocation": "<string>",
      "website": "<string>",
      "isInitiative": true,
      "town": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "nameWithCounty": "<string>",
        "county": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "name": "<string>",
          "state": "<string>"
        },
        "latitude": 123,
        "longitude": 123
      },
      "postalAddress": "<string>",
      "facebookUrl": "<string>",
      "isActive": true,
      "contactEmail": "<string>",
      "contactPhone": "<string>",
      "contactFullName": "<string>",
      "stripeAccount": "<string>",
      "localCenterStripeAccount": "<string>",
      "isStripeEligible": true,
      "isOnlinePaymentFeeEligible": true,
      "region": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "alias": "<string>",
      "isParent": true,
      "mapDescription": "<string>",
      "id": 123,
      "name": "<string>",
      "logo": "<string>",
      "status": "<string>",
      "dateCreated": "2023-11-07T05:31:56Z",
      "parent": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "parent": "<unknown>"
      }
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

​
page
integer
default:1

The collection page number

​
pagination
boolean

Enable or disable pagination

​
tenant
string
​
tenant[]
string[]
​
parent
string
​
parent[]
string[]
​
isParent
boolean
​
isParent[]
boolean[]
​
feeProduct
string
​
feeProduct[]
string[]
​
isActive
boolean
​
isActive[]
boolean[]
​
status
string
​
status[]
string[]
​
isStripeEligible
boolean
​
isStripeEligible[]
boolean[]
​
town
string
​
town[]
string[]
​
town.county
string
​
town.county[]
string[]
​
town.name
string
​
order[isInitiative]
enum<string>
default:asc
Available options:
asc,
desc
​
order[region.name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[town.name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[status]
enum<string>
default:asc
Available options:
asc,
desc
​
order[name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[town.county.name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[isActive]
enum<string>
default:asc
Available options:
asc,
desc
​
order[dateCreated]
enum<string>
default:asc
Available options:
asc,
desc
​
exists[isParent]
boolean
​
isRoleGroup
boolean
​
isRoleGroup[]
boolean[]
​
localCenter
string
​
localCenter[]
string[]
​
unitType
string
​
unitType[]
string[]
​
order[parent.name]
enum<string>
default:asc
Available options:
asc,
desc
​
order[userType.position]
enum<string>
default:asc
Available options:
asc,
desc
​
exists[isRoleGroup]
boolean
​
exists[localCenter]
boolean
​
exists[unitType]
boolean
​
exists[parent]
boolean

Response

LocalCenter collection

​
hydra:member
object[]
required
​
hydra:totalItems
integer
Required range: x >= 0
​
hydra:view
object
Example:
{
  "@id": "string",
  "type": "string",
  "hydra:first": "string",
  "hydra:last": "string",
  "hydra:previous": "string",
  "hydra:next": "string"
}
​
hydra:search
object