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
orDELETE
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.
Response Data Modifiers
You can use the following query parameters to modify the default response data.
Parameter |
Description |
---|---|
|
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 You can use the Supported methods:
Note:
The |
|
If set to any value other than Otherwise, the response will include only the internal ID of the object created or updated in the Supported methods: |