General Considerations

• Each endpoint is secured and requires authentication (see Authentication and API Keys below)
• Some GET endpoints support pagination using the per_page and page query string parameters and RFC 5988 Link and X-Total-Count HTTP headers. For more information, we recommend you see Vinay Sahni's excellent blog post on RESTFul Pagination.
• Some GET endpoints that return list values can return the localized culture-specific display value of any list values they return. Unless specified with the "culture" value, the en-US (English [United States]) translation will be returned. For a list of possible valid values for the "culture" parameter, please consult the .NET CultureInfo class documentation. Note that Dovetail is not translated into every single language. Please contact Dovetail Support for information about which languages are supported.

Authentication and API Keys

Each endpoint requires HTTP basic authentication using a valid Dovetail application username and password. For better security, Dovetail recommends that you generate separate accounts for API usage, using both cryptic user names and strong passwords.

IMPORTANT: Separation of API users from standard application users allows for greater secruity and access control to the Dovetail application.