List all locations

GET

https://api.synup.com/api/v4/locations

This API retrieves a paginated list of locations within the account, allowing for efficient data retrieval when managing multiple locations.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.synup.com/api/v4/locations?first=2&last=1&after=TG9jYXRpb246MTAw&before=' \
--header 'Authorization: API T9V35W3xxxxxxxxxxx'

Responses

🟢200OK

application/json

Successful response

Body

Example

{
    "data": {
        "allLocations": {
            "edges": [
                {
                    "cursor": "TG9jYXRpb246MTE5NTI1OA==",
                    "node": {
                        "accountId": 16154,
                        "addOns": [],
                        "additionalCategoryIds": [
                            43
                        ],
                        "additionalCategoryNames": [
                            "Playgrounds"
                        ],
                        "additionalInfo": null,
                        "additionalPhones": [],
                        "approved": "APPROVED",
                        "archivalScheduledAt": null,
                        "archived": false,
                        "archivedAt": null,
                        "bizUrl": "https://headsupcatchme.com/",
                        "bizUrlUtm": false,
                        "bookingUrl": null,
                        "businessHours": [
                            {
                                "day": "SUNDAY",
                                "slots": null,
                                "specialDate": null,
                                "type": "CLOSED"
                            },
                            {
                                "day": "MONDAY",
                                "slots": [
                                    {
                                        "end": "05:00pm",
                                        "start": "09:00am"
                                    }
                                ],
                                "specialDate": null,
                                "type": "OPEN"
                            },
                            {
                                "day": "TUESDAY",
                                "slots": [
                                    {
                                        "end": "09:00pm",
                                        "start": "09:00am"
                                    }
                                ],
                                "specialDate": null,
                                "type": "OPEN"
                            },
                            {
                                "day": "WEDNESDAY",
                                "slots": [
                                    {
                                        "end": "11:30am",
                                        "start": "09:00am"
                                    },
                                    {
                                        "end": "05:00pm",
                                        "start": "01:00pm"
                                    },
                                    {
                                        "end": "09:30pm",
                                        "start": "06:00pm"
                                    }
                                ],
                                "specialDate": null,
                                "type": "OPEN"
                            },
                            {
                                "day": "THURSDAY",
                                "slots": null,
                                "specialDate": null,
                                "type": "OPEN_24x7"
                            },
                            {
                                "day": "FRIDAY",
                                "slots": null,
                                "specialDate": null,
                                "type": "CLOSED"
                            },
                            {
                                "day": "SATURDAY",
                                "slots": null,
                                "specialDate": null,
                                "type": "CLOSED"
                            }
                        ],
                        "cancellationScheduledAt": null,
                        "categoryId": 59,
                        "city": "Setauket- East Setauket",
                        "countryIso": "US",
                        "createErrors": [
                            {
                                "fieldName": "base",
                                "messages": [
                                    "A Location with same name, phone number and zip code has already been added."
                                ]
                            },
                            {
                                "fieldName": "storeId",
                                "messages": [
                                    "Store has already been taken"
                                ]
                            }
                        ],
                        "createdDate": "February 19, 2025",
                        "customAttributes": [
                            {
                                "archived": false,
                                "enumValues": [],
                                "name": "bollean01",

🟠400Bad Request

Modified at 2025-07-15 12:16:36

Update business location

List particular locations