GET /api/locations
Index of all Locations

Examples

$ curl -i \
  -H "Accept: application/json; version=1" \
  -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
  "https://api.record360.com/api/locations?after_id=88&limit=2"

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate

{
  "locations": [
    {
      "id": "89",
      "name": "Main Office",
      "address1": "4726 Thackeray Pl NE",
      "address2": "Suite 405",
      "city": "Seattle",
      "state": "WA",
      "zipcode": "98105",
      "timezone": "PST",
      "created_at": "2014-04-01T19:00:00.000Z",
      "updated_at": "2016-04-14T21:46:56.000Z",
      "workflow": { ... }
    },
    {
      "id": "90",
      "name": "Branch Office",
      "address1": "4726 Thackeray Pl NE",
      "city": "Rockford",
      "state": "IL",
      "zipcode": "61101",
      "timezone": "CST",
      "created_at": "2014-04-01T19:00:00.000Z",
      "updated_at": "2016-04-14T21:46:56.000Z",
      "workflow": { ... }
    },
    ...
  ],
  "links": {
    "prev": "https://api.record360.com/api/locations?before_id=89&limit=2",
    "next": "https://api.record360.com/api/locations?after_id=90&limit=2"
  }
}

Params

Param name Description
before_id
optional

Return Locations before the specified ID

Validations:

  • Must be a String

after_id
optional

Return Locations after the specified ID

Validations:

  • Must be a String

limit
optional

Limit the number of Locations to return (max: 50)

Validations:

  • Must be a number.


GET /api/locations/:id
Show a particular Location

Examples

 $ curl -i \
   -H "Accept: application/json; version=1" \
   -H "Authorization: Token eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjQyLCJpYXQiOjE0NjM2OTQ4MjN9.k48v-R-un93KdIXqp9Zi12JOGJCu8uibtrWjscFCTqc" \
   https://api.record360.com/api/locations/42

HTTP/1.1 200 OK
 Content-Type: application/json; charset=utf-8
 Cache-Control: max-age=0, private, must-revalidate

 {
   "location": {
     "id": "42",
     "name": "Main Office",
     "address1": "4726 Thackeray Pl NE",
     "address2": "Suite 405",
     "city": "Seattle",
     "state": "WA",
     "zipcode": "98105",
     "timezone": "PST",
     "created_at": "2014-04-01T19:00:00.000Z",
     "updated_at": "2016-04-14T21:46:56.000Z",
     "workflow": { ... }
   }
 }

Params

Param name Description
id
required

Location ID

Validations:

  • Must be a number.