Skip to main content

Response Headers

All responses to API requests will include the following response headers:

header description
Content-Type Set to match the value of the request's Accept header unless an error occurred, in which case it will be set to application/json. Possible values include application/json and text/plain.
Record-Total Total records found at the time of the request. Use this value when paging through large datasets to determine when all data has been retrieved.
Record-Offset Set to match the offset value provided with the request.
Record-Limit Set to match the limit value provided with the request or the platform maximum limit, whichever is smaller. 
Record-Max-Limit (available 4/6/2020) Set to the maximum number of records that will be returned by the platform, regardless of the size of the response payload. Use this header to build an API client that can adapt to future record limit value changes.
Response-Payload_Max_Size (available 4/6/2020) Set to the maximum payload size (in MB) that will be returned by the platform, regardless of the number of records returned. Use this header to build an API client that can adapt to future response payload size changes.