Skip to main content
GET
Requires location:read and project API access. Returns a data array with pagination links and meta.
​
string
required
The public project ID returned by List projects.
​
integer
default:"1"
Page to retrieve.
​
integer
default:"15"
Page size. Use 1 to 100; larger values use the default size.
​
integer
Send 1 to include the hours object, or null if there is no schedule.
​
integer
Send 1 to include the filters array.
​
integer
Send 1 to include the custom-fields array.
​
integer
Send 1 to include the calls-to-action array.
Omit an include flag or use 0 to leave that relationship out. Use numeric 1/0, rather than the string false.

​
Supported filters

Use bracket notation, such as city[eq]=Seattle or name[like]=Downtown. like matches a substring. Supplied filters are combined. The query field is postalCode, although the location response uses postcode. Plain city=Seattle, postcode=98101, and visible are not supported list filters. Use --data-urlencode in curl for bracketed parameters.

​
Response

Each element of data uses the location response format. Follow links.next until it is null, or use meta.current_page and meta.last_page. Errors: 401 authentication, 403 access/permission, 404 inaccessible project, 429 rate limit. See errors.