clubs
location

List all locations

Changed on

Returns a list of ClubsLocations. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

get/clubs/{connection_id}/location

Request

  • Base URL
    https://api.unified.to
  • URL
    https://api.unified.to/clubs/{connection_id}/location
  • Auth
    API key in header authorization

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

group_idstring

The group ID to filter by (reference to HrisGroup)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for this location

created_atstring date-time

The date that this location was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this location was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

group_idstring

The group this location is associated with (reference to HrisGroup)

namestring

The location name

latitudenumber

The latitude

longitudenumber

The longitude

telephonestring

A contact phone number for the location

urlstring

A URL for the location

rawobject

The raw data returned by the integration for this location

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status