Examples

The examples in the docs are curl statements. You can run the statements on a command line to try out different API requests. To learn more, see Installing and using curl. In Windows, you'll need to modify some of the examples in the docs to make them work. See Using curl in Windows.

If you use a password to authenticate your curl requests, make sure to escape any special characters in the password. Example: pa$$word becomes pa\$\$word.

You can also use Postman to try out different requests.

The examples use basic authentication requiring a Zendesk username and password. Make sure to enable password access in the Admin Center interface at Apps and integrations > APIs > Zendesk API.

Note:

  • While basic authentication is recommended for manual curl requests, it is not recommended for production use.
  • Code samples are for reference only. Review and validate the intended action before use.