Skip to main content
The API key identifies your organization to ContactShip’s public API. The app supports one key per organization. Your plan must include API access; administrative permissions do not replace that requirement.

​
Generate and use

  1. Select the organization your integration will work with.
  2. Open API keys and generate a key.
  3. Copy it into the private configuration of your server or automation tool.
  4. Send it in the x-api-key request header.
Replace YOUR_API_KEY in your private environment. Do not place keys in public webpages, URLs, screenshots or support tickets.

​
Permissions and availability

The screen does not offer individual keys with custom permissions or scopes. Do not assume a key has the same restricted scope as a human member.

​
Delete or replace

Deleting a key interrupts integrations that use it. Identify dependent systems before replacing it and update their credentials.
Coordinate deletion, generation and dependent system updates. A coexistence period for old and new keys is not documented.

​
Common problems

​
Frequently asked questions

Each key belongs to one organization. Configure separate credentials for different organizations.
The current configurator does not provide per-key scopes. Do not treat a key as a read-only credential.
Send the method, path, time and response status. Redact the key and other secrets.

​
See also