Returned Data

The response object includes a data property for all successful POST, GET, PUT or DELETE requests. The content of the data array depends on the method used in the request. By default, data contains:

A single object or up to 1000 objects, if you use a GET request to retrieve a single resource or a list of resources. The object contains key-value pairs for all fields. For more information about fields returned, see REST API Endpoint Reference or Generated API Documentation JSON.
The internal ID of the object created, updated, or deleted, if you use a POST, PUT or DELETE request to insert, modify or delete a resource.

The response object includes a meta property for successful requests if the response is paginated, or if there are objects referenced by internal ID in the data array that support expansion. See Pagination and Referenced Objects and Expansion.

Note:

The API uses cached filter set information —information about objects which the authenticated user can access according to the filter set assigned to that user— to optimize performance. By default, GET requests using a valid access token do not return objects created after the access token was issued in the response, even if the user can access the new objects in the UI. If new objects are expected, you can clear and regenerate the cached filter set information by sending a POST request to the filter set cache refresh endpoint. Subsequent GET requests to resource endpoints return the latest available data including any objects that were created recently. See Filter Set Cache Refresh.

Response Data Modifiers

You can use the following query parameters to modify the default response data.

Parameter	Description
`fields`	A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for each object returned. The comma-separated list may include spaces (or `%20` in the URL encoded string). You can use the `fields` query parameter to return exactly the fields you need in the response. Supported methods: `POST`, `GET`, `PUT`. Note: The `GET /contacts/` and `GET /job-codes/` methods to retrieve a list of contacts and job codes, respectively, do not currently support the `fields` parameter.
`return_object`	If set to any value other than `0` (zero), the response will include the object created or updated in the `data` array. You can use both the `return_object` and `fields` parameters to return exactly the fields you need. Otherwise, the response will include only the internal ID of the object created or updated in the `data` array. Supported methods: `POST`, `PUT`.

Parameter

Description

fields

A comma-separated list of attributes to include in the response. If not specified, the response includes all attributes for each object returned. The comma-separated list may include spaces (or %20 in the URL encoded string).

You can use the fields query parameter to return exactly the fields you need in the response.

Supported methods: POST, GET, PUT.

Note:

The GET /contacts/ and GET /job-codes/ methods to retrieve a list of contacts and job codes, respectively, do not currently support the fields parameter.

return_object

If set to any value other than 0 (zero), the response will include the object created or updated in the data array. You can use both the return_object and fields parameters to return exactly the fields you need.

Otherwise, the response will include only the internal ID of the object created or updated in the data array.

Supported methods: POST, PUT.